Current File : //lib/python2.7/site-packages/salt/modules/bcache.pyc
�
���^c @@ sy d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l m
Z
d d l Z e j
e � Z i e j d 6e j d 6e j d 6e j d 6e j d 6e j d
6Z i d d 6d
d 6d d 6Z e j j j d � d k Z d � Z d d � Z d d � Z d d � Z d � Z! d d � Z" d e# e$ d d � Z% d e# d d e$ d � Z& d d � Z' e# e# e# e# e# d � Z( e# e# e# e# d � Z) d � Z* d � Z+ d � Z, d! � Z- d d" � Z. d# � Z/ d$ � Z0 d d d d% � Z1 d d d d& � Z2 d d d d' � Z3 d e# e# e# e# d( � Z4 d) � Z5 d* � Z6 d+ � Z7 d d d, d- � Z8 d d d d. � Z9 d/ � Z: d S(0 u�
Module for managing BCache sets
BCache is a block-level caching mechanism similar to ZFS L2ARC/ZIL, dm-cache and fscache.
It works by formatting one block device as a cache set, then adding backend devices
(which need to be formatted as such) to the set and activating them.
It's available in Linux mainline kernel since 3.10
https://www.kernel.org/doc/Documentation/bcache.txt
This module needs the bcache userspace tools to function.
.. versionadded: 2016.3.0
i ( t absolute_importt print_functiont unicode_literalsN( t sixu traceu debugu infou warnu erroru critu attachu attach_u configu config_u superu super_u
blkdiscardc C@ s t j j j d � d k S( u1
Only work when make-bcache is installed
u make-bcacheN( t saltt utilst patht whicht None( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt __virtual__2 s c C@ sg yN | d k r4 t t j j j d � � d d d St j j t | d � � SWn t k
rb t
SXd S( u
Return the bcache UUID of a block device.
If no device is given, the Cache UUID is returned.
CLI example:
.. code-block:: bash
salt '*' bcache.uuid
salt '*' bcache.uuid /dev/sda
salt '*' bcache.uuid bcache0
u /sys/fs/bcache/i i u cacheN( R t listR R R t os_walkt ost basenamet _bcsyst Exceptiont False( t dev( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt uuid9 s %
c @ s< t � � � s# t j d � � t S� d k r� i } xB t d t � j � D]+ \ � } d | k rK t � � | � <qK qK Wt | � r� | Sd Sn t � � } | r� | � k r� t j
d � � � d St � � s� t Sn t j d � � � t
� d � d d j � � � � st St � � f d � d d
j � � � � S( u
Attach a backing devices to a cache set
If no dev is given, all backing devices will be attached.
CLI example:
.. code-block:: bash
salt '*' bcache.attach sdc
salt '*' bcache.attach /dev/bcache1
:return: bool or None if nuttin' happened
u No cache to attach %s tot alldevsu cacheu2 %s is already attached to bcache %s, doing nothingu Attaching %s to bcache %su attachu erroru! Error attaching {0} to bcache {1}c @ s t � � � k S( N( R ( ( t cacheR ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt <lambda> s u5 {0} received attach to bcache {1}, but did not complyN( R t logt errorR R t statust Truet itemst attach_t lent infot detacht debugR t formatt _wait( R t rest datat bcache( ( R R s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR R s2 " c @ s� � d k rn i } xB t d t � j � D]+ \ � } d | k r( t � � | � <q( q( Wt | � rg | Sd Sn t j d � � t � d d d d j � � � s� t
St � f d � d d j � � d
� S( u�
Detach a backing device(s) from a cache set
If no dev is given, all backing devices will be attached.
Detaching a backing device will flush it's write cache.
This should leave the underlying device in a consistent state, but might take a while.
CLI example:
.. code-block:: bash
salt '*' bcache.detach sdc
salt '*' bcache.detach bcache1
R u cacheu Detaching %su detachu goawayu erroru Error detaching {0}c @ s t � � t k S( N( R R ( ( R ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR � s u' {0} received detach, but did not complyi, N( R R R R R R R R R R R R! ( R R" R# ( ( R s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR � s " !c C@ s3 t d d d � s t St d � d d � s/ t St S( u�
Trigger a start of the full bcache system through udev.
CLI example:
.. code-block:: bash
salt '*' bcache.start
u udevadm triggeru erroru Error starting bcache: %sc S@ s
t � t k S( N( R R ( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR � s u warnu5 Bcache system started, but no active cache set found.( t _run_allR R! R ( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt start� s
c @ s� � d
k rf t j d � � t � d d d d j � � � sA t St � f d � d d j � � d � St � } | s� t j d � d
St t � � s� t St
d d d d
� s� t St d � d d d � Sd
S( u�
Stop a bcache device
If no device is given, all backing devices will be detached from the cache, which will subsequently be stopped.
.. warning::
'Stop' on an individual backing device means hard-stop;
no attempt at flushing will be done and the bcache device will seemingly 'disappear' from the device lists
CLI example:
.. code-block:: bash
salt '*' bcache.stop
u; Stopping %s, device will only reappear after reregistering!u stopu goawayu erroru Error stopping {0}c @ s t t � � � t k S( N( t _sysfs_attrt _bcpathR ( ( R ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR � s u Device {0} did not stopi, u bcache already stopped?u Error stopping cachec S@ s
t � t k S( N( R R ( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR � s u Cache did not stopN( R R t warningR R R R! R t _alltrueR t _fssys( R R ( ( R s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt stop� s !%
u writebackc @ si t � } | s t j d � t St t � � � r| | sL t j d � � t St � � ri t � � ri t St � � s| t Sn t � � � t t
d � � } | d
k r� t t
d � � } n d j | | | � � } | r� | d 7} n t
| d d j � � � st St d t � � d d
j � � � s-t St � f d � d d j � � � sUt S| ret � � St S( u�
Create a backing device for attachment to a set.
Because the block size must be the same, a cache set already needs to exist.
CLI example:
.. code-block:: bash
salt '*' bcache.back_make sdc cache_mode=writeback attach=True
:param cache_mode: writethrough, writeback, writearound or none.
:param force: Overwrite existing bcaches
:param attach: Immediately attach the backing device to the set
:param bucket_size: Size of a bucket (see kernel doc)
u No bcache set foundu; %s already contains a bcache. Wipe it manually or use forceu
block_sizeu bucket_sizeu5 make-bcache --block {0} --bucket {1} --{2} --bdev {3}u --wipe-bcacheu erroru% Error creating backing device {0}: %su fs/bcache/registeru$ Error registering backing device {0}c @ s t t � � � t k S( N( R' R( R ( ( R ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR s u# Backing device {0} did not registerN( R R R R R' R( R R, t _devpatht _size_mapR+ R R R% R! R R ( R t
cache_modet forcet attacht bucket_sizeR t
block_sizet cmd( ( R s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt back_make� s<
c C@ s t � } | r5 | s) t j d | � t St � } n t | � } t d | � } d | k s� | j d d � d k r� d | k r� | r� t j d | � t S| d k r� | j d d � d k r� t j d � t St | � \ } } }
| d k r|
} t } n | d k r| } n | r<t
� s)t St | � s<t Sn t | � sLt S| r�d
j | | � } t
| d d j | � � s�t Sd
j | � } n d j | | � } | r�| d j | � 7} n t
| d d j | � � s�t St d � d d j | � � st S| rt t � � St Sd S( u�
Create BCache cache on a block device.
If blkdiscard is available the entire device will be properly cleared in advance.
CLI example:
.. code-block:: bash
salt '*' bcache.cache_make sdb reserved=10% block_size=4096
:param reserved: if dev is a full device, create a partition table with this size empty.
.. note::
this increases the amount of reserved space available to SSD garbage collectors,
potentially (vastly) increasing performance
:param block_size: Block size of the cache; defaults to devices' logical block size
:param force: Overwrite existing BCache sets
:param attach: Attach all existing backend devices immediately
u( BCache cache %s is already on the systemu udev.envu
ID_FS_TYPEu DEVTYPEu partitionu ID_PART_TABLE_TYPEu- %s already contains data, wipe first or forceu disku2 Need a partitionable blockdev for reserved to workud parted -m -s -a optimal -- /dev/{0} mklabel gpt mkpart bcache-reserved 1M {1} mkpart bcache {1} 100%u erroru+ Error creating bcache partitions on {0}: %su {0}2u6 make-bcache --cache /dev/{0} --block {1} --wipe-bcacheu
--bucket {0}u Error creating cache {0}: %sc S@ s
t � t k S( N( R R ( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR d s u7 Cache {0} seemingly created OK, but FS did not activateN( R R R R t _bdevt _devbaset __salt__t getR t _sizesR, t _wipeR R% R! R* R R ( R t reservedR0 R3 R2 R1 R t udevt _t blockt bucketR4 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt
cache_make sZ 0$
c
K@ sF | d
k r t � } n t | � } t g | j � D]' \ } } | j d � s4 | | f ^ q4 � } | r� d } xT | j � D]F \ } } | t | | g | d d j t j j
| | � | � � 7} q} W| d k Si } t | d t d t d t �} x$ d D] } | | k r� | | =q� q� Wx | D] } | j
| | � q#W| Sd
S( u�
Show or update config of a bcache device.
If no device is given, operate on the cache set itself.
CLI example:
.. code-block:: bash
salt '*' bcache.config
salt '*' bcache.config bcache1
salt '*' bcache.config errors=panic journal_delay_ms=150
salt '*' bcache.config bcache1 cache_mode=writeback writeback_percent=15
:return: config or True/False
u __i u warnu Failed to update {0} with {1}t configt internalst optionsu other_rou inter_roN( u other_rou inter_ro( R t _fspathR( t dictR t
startswithR' R R R t joint _sysfs_parseR t update( R t kwargst spatht keyt valt updatest endrest resultR# ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt config_n s$ @,
c C@ sl g } x� t j j j d � D]� \ } } } x� | D]x } d | k rJ q2 n x] t j j j d j | � d t �D]7 \ } }
} d |
k ro | j t j j | � � qo qo Wq2 Wq Wi } x* | D]" } t | | | | | � | | <q� Wt
� }
t � } | rhd } x> | D]6 } | | k r
| | d |
k r@| d 7} q@q
q
W| | | d <| sh| | } qhn | S( u�
Show the full status of the BCache system and optionally all it's involved devices
CLI example:
.. code-block:: bash
salt '*' bcache.status
salt '*' bcache.status stats=True
salt '*' bcache.status internals=True alldevs=True
:param stats: include statistics
:param config: include settings
:param internals: include internals
:param superblock: include superblock
u /sys/block/u bcacheu /sys/block/{0}t followlinksi u cachei u attached_backing_devices( R R R R R R t appendR R
t deviceR R6 ( t statsRB RC t
superblockR t bdevsR> t linksR? RL t sdirst statiiR$ t cuuidt cdevt countR ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR � s. %
4 (
c C@ s� i } t t | � d$ d d j | � � s. t St | d � r� t � | d <d d d d d g } | j t t | � | | | | � � | j t t � | | | | � � | j | j
d
� � n=t | � } | d$ k r� | | d <n y# t j j
t | d � � | d <Wn t k
rn Xt | � | d
<d d d d g } t | � } | j t | | | | | � � | j | j
d
� � | d g } | j
d � r�| j d � n
| j d � d | k r�| j
d � r�| j d � q�| j d � n | | d <d | k r�d }
| d } x� | d D]� } d | k r`t j |
d | � }
| j
| � | |
<q#| j d d � \ } }
t j |
d | � } t j |
d |
� }
| | k r�i | | <n | j
| � | | |
<q#W| | d <n | r�| j
d i � } | j | j
d i � � t | � r�x� | D]� }
|
j d � rmt j d d |
� } | j
|
� | | <| }
n |
j d% � r't j d |
d d �\ } } | | k r�i | | <n | j
|
� | | | <q'q'W| | d! <q�n | ro| d" } xn | D]f }
|
j d � r�t j d |
d d �\ } } | | k rDi | | <n | j
|
� | | | <q�q�W| | d" <n | r�t | � | d# <n | S(& ue
Check the state of a single bcache device
CLI example:
.. code-block:: bash
salt '*' bcache.device bcache0
salt '*' bcache.device /dev/sdc stats=True
:param stats: include statistics
:param settings: include all settings
:param internals: include all internals
:param superblock: include superblock info
u erroru {0} is not a bcache fo any kindu setu uuidu
block_sizeu bucket_sizeu cache_available_percentu cache_replacement_policyu congestedu baseu cacheu devu bdevu
cache_modeu runningu stateu writeback_runningu stoppedu writeback_stoppedu statsu (stats|cache)_u /u i u inter_rou inter_rwu internalu
internal[s/]*u btreeu writebacku _t maxsplitu internalsu configu
superblockN( u btreeu writeback( R' R( R R R R R RJ RI RE t popR R R
R R6 RT t ret subt splitR RG t super_( R RV RB RC RW RQ t base_attrt back_uuidt base_patht statet replret statrest attrRM t statt interrest nkeyt mkeyt skeyt configres( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyRU � s� $
%"
#
c C@ s� t | � } i } t d j | � d d j | � � } | s@ t Sx�| j � D]�} | j � } | sk qM n g t j d | d d �D] } | j � ^ q� \ } } | o� | s� qM n d } d | k r
g t j d | d d �D] } | j � ^ q� \ } } | d d !} n | } y t | � } Wn_ t
k
r�y t | � } Wq�t
k
r�| d k rht } q�| d
k r�t } q�q�Xn Xt j d | d d �\ } } | | k r�i | | <n | d k r�| | f | | | <qM | | | | <qM W| S(
u�
Read out BCache SuperBlock
CLI example:
.. code-block:: bash
salt '*' bcache.device bcache0
salt '*' bcache.device /dev/sdc
u bcache-super-show {0}u erroru# Error reading superblock on {0}: %su [\s]+R_ i u i����u yesu nou \.N(
R- R% R R t
splitlinest stripRa Rc R t intR t floatR ( R t retR" t lineRN RM t mvalt rvalt pkey( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyRd : sD $ 7 7
c C@ s4 t j j t j j | � � } t j j | � } | S( u(
Basename of just about any dev
( R R t realpatht
expandvarsR
( R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR7 v s c C@ s t j j d t | � � S( uM
Return /dev name of just about any dev
:return: /dev/devicename
u /dev( R R RH R7 ( R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR- s c C@ s4 t | � } t j d d | � } t j j d | � S( u%
Full SysFS path of a device
u ^([vhs][a-z]+)([0-9]+)u \1/\1\2u /sys/block/( R7 Ra Rb R R RH ( R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt _syspath� s c C@ sZ | d k r t d � } n t | � } | s1 t St t j j t j j | d � � � Sd S( uV
Resolve a bcacheX or cache to a real dev
:return: basename of bcache dev
u cache0u ../N( R R+ R( R R7 R R R{ RH ( R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR6 � s c C@ s t j j t | � d � S( u,
Full SysFS path of a bcache device
u bcache( R R RH R} ( R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR( � s c C@ s* t � } | s t St j j d | � Sd S( u(
:return: path of active bcache
u /sys/fs/bcache/N( R R R R RH ( R\ ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyRE � s c C@ s0 t � } | s t St | | g | | | � Sd S( u7
Simple wrapper to interface with bcache SysFS
N( RE R R' ( t namet valuet log_lvlt log_msgt fspath( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR+ � s c C@ s t t | � | g | | | � S( u=
Simple wrapper to interface with backing devs SysFS
( R' R( ( R R~ R R� R� ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR � s c C@ sw t | t j � r | g } n t d t j j | � | � } | rs | d k rs | d k rs t j t | | � n | S( u7
Simple wrapper with logging around sysfs.attr
u
sysfs.attrN(
t
isinstanceR t string_typesR8 R R RH R R t LOG( R~ R R� R� R" ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR' � s c C@ s` i } t d | � } | d =g } | r? | j d d g � n | rU | j d � n | rk | j d � n i } x | D] }
g | |
<qx Wxe | d D]Y } | j d � r� d }
n d | k r� d }
n d }
|
| k r� | |
j | � q� q� WxP | d D]D } | j d � r d }
n d }
|
| k r� | |
j | � q� q� W| d k r�x; | D]3 } g | | D] } | | k rk| ^ qk| | <qZW| | d
<n i d d d
d d d d g d 6}
x� |
j � D]� \ } } g } | | k r�q�n xN | D]F } x= | j � D]/ } | | k r | j | � | j | � q q Wq�W| | c | 7<q�Wg | j � D] } | D] } | ^ qmqc} | j t d | | � � x� d D]� } | | k r�i } x� | | j d � D]� } | j d d � \ }
} | j
� } y t | � } Wn5 t k
r@y t
| � } WqAt k
r<qAXn X| | |
j
� <q�W| | | <q�q�W| s�xD d! D]9 } | | k rst j d | | � j � d | | <qsqsWn x1 d" D]) } | | k r�t | | � | | <q�q�Wi } xl | j � D]^ \ } } i } x0 | D]( } | | k r| j | � | | <qqWt | � r�| | | <q�q�W| S(# u>
Helper function for parsing BCache's SysFS interface
u sysfs.interfacesu wu inter_rou inter_rwu configu statsu ru internalu rwu baseu internal/bset_tree_statsu writeback_rate_debugu metadata_writtenu nbucketsu writtenu average_key_sizeu btree_cache_sizeu
sysfs.readu priority_statsu
u :i u
cache_modeu cache_replacement_policyu errorsu \[(.+)\]i u runningu writeback_runningu congestedN( u writeback_rate_debugu internal/bset_tree_statsu priority_stats( u
cache_modeu cache_replacement_policyu errors( u runningu writeback_runningu congested( R8 t extendRT RG R R t valuest removeRJ Rc Rs Rt R Ru Ra t searcht groupst boolR` R ( R Re RV RB RC RD RQ t intfst binkeyst bintfRM t intft sintft modst modtt modlistt foundt modt intflistt iflistt bintflistt strlistt listresRw RN t sellistt boolkeyt bresultt iftypet ifres( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyRI � s�
1
,
.
c C@ s� y� t | t � s� t j d | � rF d t t j d d | � � } n4 t j d | � rz d t t j d d | � � } n t | � } n | SWn t k
r� d SXd S( u1
Map Bcache's size strings to real bytes
u [Kk]i u u [Mm]i Ni ( R� Rt Ra R� Ru Rb R R ( t size( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR. C s ""
c C@ s� t | � } d } d } t d d d
t | � �} | j d | j d d � � } | j d | j d
d � � } d | d | | f S( u�
Return neigh useless sizing info about a blockdev
:return: (total size in blocks, blocksize, maximum discard size in bytes)
u hw_sector_sizeu minimum_io_sizeu physical_block_sizeu logical_block_sizeu discard_max_bytesu discard_max_hw_bytesu
sysfs.readu sizeu queue/hw_sector_sizeu ../queue/hw_sector_sizeu queue/discard_max_bytesu ../queue/discard_max_bytest rooti ( u hw_sector_sizeu minimum_io_sizeu physical_block_sizeu logical_block_size( u discard_max_bytesu discard_max_hw_bytes( u sizeu queue/hw_sector_sizeu ../queue/hw_sector_sizeu queue/discard_max_bytesu ../queue/discard_max_bytesN( R7 R8 R} R9 R ( R t block_sizest
discard_sizest sysfst discardR? ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR: U s
c C@ sI d } t | � } t | � \ } } } | d k rG t j d | � d S| sf t j d | � d } n" t s� t j d � d } n d } d j | � } | d k rd } d j | | � } | t | d
| � 7} | d j | d | � 7} | t | d
| � 7} n: | d k r?d j | � } | t | d
| � 7} d } n | d k S( u.
REALLY DESTRUCTIVE STUFF RIGHT AHEAD
i u! Unable to read SysFS props for %su %s seems unable to discardu dduS blkdiscard binary not available, properly wipe the dev manually for optimal resultsu
blkdiscardu Error wiping {0}: %si u+ dd if=/dev/zero of=/dev/{0} bs=1M count={1}u warnu seek={0}i i u blkdiscard /dev/{0}i Ni ( R7 R: R R R R) t HAS_BLKDISCARDR R% ( R RP R� R? R� t wipert wipe_failmsgt blocksR4 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR; w s2
i
c C@ sd d } x4 | | k r< t j d � | � r/ t S| d 7} q W| d k r` t j t | | � n t S( ui
Wait for lfunc to be True
:return: True if lfunc succeeded within tries, False if it didn't
i i N( t timet sleepR R R R� R ( t lfuncR� R� t triest i( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR! � s
c C@ sg t d | � } | d | k r9 | d r2 | d St Sn | d k rc t j t | | | d � n t S( u�
Simple wrapper around cmd.run_all
log_msg can contain {0} for stderr
:return: True or stdout, False if retcode wasn't exitcode
u cmd.run_allu retcodeu stdoutu stderrN( R8 R R R R� R ( R4 R� R� t exitcodeR" ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR% � s
c C@ s? | d k r t St g | j � D] } | r | ^ q � d k S( Ni ( R R R R� ( t resdictRN ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyR* � s (; t __doc__t
__future__R R R t loggingR R� Ra t salt.extR t salt.utils.pathR t getLoggert __name__R t TRACEt DEBUGt INFOt WARNINGt ERRORt CRITICALR� t __func_alias__R R R R R� R R R R R& R, R R R5 RA RR R RU Rd R7 R- R} R6 R( RE R+ R R' RI R. R: R; R! R% R* ( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/bcache.pyt <module> s`
1 ! #8] ,/q < q " (
Mini Shell