Sindbad~EG File Manager
3
x?ag�E � @ s� d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZmZm Z m
Z
ddl Z ddl Z ddl
Z
ddlZG d d
� d
e
e�ZG d d � d e�ZdS )
zx
Defaults - manage Albireo/VDO defaults
$Id: //eng/vdo-releases/aluminum/src/python/vdo/vdomgmnt/Defaults.py#11 $
� )�absolute_import)�division)�print_function)�unicode_literals� )� Constants�
MgmntUtils�
SizeString�UserExitStatusNc s( e Zd ZdZ� fdd�Zdd� Z� ZS )�
ArgumentErrorz7Exception raised to indicate an error with an argument.c s t t| �j||� || _d S )N)�superr �__init__�_msg)�self�msg�args�kwargs)� __class__� � /usr/lib/python3.6/Defaults.pyr
* s zArgumentError.__init__c C s | j S )N)r )r r r r �__str__/ s zArgumentError.__str__)�__name__�
__module__� __qualname__�__doc__r
r �
__classcell__r r )r r r $ s r c @ s` e Zd ZdZdWZdZdZdZej Z
dZ dZ dZ
dZdZdZdZed �Zed
�Zed �Zd ej Zd Zd ZdZdZ e j d
d�d Z e j dd�Z ej Z!ej Z"dZ#dZ$dZ%ej&Z'dZ(dZ)dZ*dZ+dZ,dZ-ed�Z.dZ/dZ0dZ1dZ2ed�Z3ed�Z4ed�Z5dZ6dZ7dZ8d Z9dZ:ed�Z;ed �Z<ed �Z=ej&Z>dZ?d Z@d ZAd ZBd d!d"d#d d$gZCd%ZDd&ZEd'd(d)d&gZFeGd*d+� �ZHeGd,d-� �ZIeGd.d/� �ZJeGd0d1� �ZKeGd2d3� �ZLeGd4d5� �ZMeGd6d7� �ZNeGd8d9� �ZOeGd:d;� �ZPeGd<d=� �ZQeGd>d?� �ZReGd@dA� �ZSeGdBdC� �ZTeGdDdE� �ZUeGdFdG� �ZVeGdHdI� �ZWeGdJdK� �ZXeGdLdM� �ZYeGdNdO� �ZZdPdQ� Z[eGdRdS� �Z\eGdTdU� �Z]dVS )X�Defaultsz.Defaults manages default values for arguments.r �d r �@ i � � Z128MZ16T� i�? Z VDO_CONF_DIRz/etcz /vdoconf.ymlZVDO_CONVERSION_UTILITY_DIRz /usr/libexec� g �?Z4096T� �< Z4KZ4GZon�
Z2GZ32G� i �infoZcritical�errorZwarningZnotice�debugZvdo�auto�asyncz async-unsafe�syncc C s t jj| �r| S ttd���dS )z�Checks that an option is an absolute pathname.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The pathname as a string.
Raises:
ArgumentError
z must be an absolute pathnameN)�os�path�isabsr �_)�valuer r r � checkAbspathv s zDefaults.checkAbspathc C s
t j| �S )z�Checks that an option is a valid name for the backing store.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The backing store name as a string.
Raises:
ArgumentError
)r r2 )r1 r r r � checkBlkDev� s zDefaults.checkBlkDevc C s t jt jt j| �S )a) Checks that an option is an acceptable value for the block map period.
The number must be at least 1 and no bigger than 16380.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to an int.
Raises:
ArgumentError
)r � _rangeCheck�blockMapPeriodMin�blockMapPeriodMax)r1 r r r �checkBlockMapPeriod� s z Defaults.checkBlockMapPeriodc C s$ | dk r t jj| � r tj| �S | S )a@ Checks that an option specifies a possible config file path name.
Currently the only restriction is that the if the path already
exists, it must be a regular file.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value.
Raises:
ArgumentError
N)r- r. �isfiler � _checkNotBlockFileOrDirectory)r1 r r r �
checkConfFile� s
zDefaults.checkConfFilec C s� | j dd�} yH| dks&| dks&| dkr*| S t| �}tj| koHtjkn rR| S W n tk
rh Y nX ttd�jtjtj���dS )aY Checks that an option is a legitimate index memory setting.
To handle non-US locales while still supporting the documented
behavior, we allow either a period or a comma as the decimal
separator. This will be normalized to the decimal-point
representation; internally indexMem is always either the string
representation of an integer or one of the exact strings '0.25',
'0.5', or '0.75' regardless of locale.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The memory setting as a string.
Raises:
ArgumentError
�,�.z0.25z0.5z0.75zpmust be an integer at least {0} and less than or equal to {1} or one of the special values of 0.25, 0.5, or 0.75N) �replace�intr �indexMemIntMin�indexMemIntMax�
ValueErrorr r0 �format)r1 �numberr r r �
checkIndexmem� s zDefaults.checkIndexmemc C s
t j| �S )a` Checks that an option specifies a possible log file path name.
Currently the only restriction is that the path name may not refer
to an existing block device node or directory in the file system.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value.
Raises:
ArgumentError
)r r9 )r1 r r r � checkLogFile� s zDefaults.checkLogFilec C s, t j| �}|t jks(ttd�jt j���|S )z�Checks that an option is an LVM-style size string.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to a SizeString.
Raises:
ArgumentError
z!must be less than or equal to {0})r � checkSize�logicalSizeMaxr r0 rB )r1 �ssr r r �checkLogicalSize� s
zDefaults.checkLogicalSizec C sB t j| �}t j| ko t jk n s>ttd�jt jt j���|S )aY Checks that an option is an acceptable value for max discard size.
Max discard sizes will be rounded to a multiple of 4k, and must be at
least 4k and less than 4GB.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to a SizeString.
Raises:
ArgumentError
z&must be at least {0} and less than {1})r � checkSiSize�maxDiscardSizeMin�maxDiscardSizeMaxPlusOner r0 rB )r1 rH r r r �checkMaxDiscardSize s
z Defaults.checkMaxDiscardSizec C sB t j| �}t j| ko t jk n s>ttd�jt jt j���|S )ak Checks that an option is an acceptable value for the page cache size.
Page cache sizes will be rounded up to a multiple of the page size, and
must be at least 128M and less than 16T.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to a SizeString.
Raises:
ArgumentError
z&must be at least {0} and less than {1})r rJ �blockMapCacheSizeMin�blockMapCacheSizeMaxPlusOner r0 rB )r1 rH r r r �checkPageCachesz s
zDefaults.checkPageCacheszc C s t jt jt j| �S )z�Checks that an option is a valid "physical" thread count.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to an integer.
Raises:
ArgumentError
)r r4 �physicalThreadsMin�physicalThreadsMax)r1 r r r �checkPhysicalThreadCount/ s z!Defaults.checkPhysicalThreadCountc C s t jt jt j| �S )z�Checks that an option is a valid "logical" thread count.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to an integer.
Raises:
ArgumentError
)r r4 �logicalThreadsMin�logicalThreadsMax)r1 r r r �checkLogicalThreadCount@ s z Defaults.checkLogicalThreadCountc C s t jt jt j| �S )z�Checks that an option is a valid bio rotation interval.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to an integer.
Raises:
ArgumentError
)r r4 �bioRotationIntervalMin�bioRotationIntervalMax)r1 r r r �checkRotationIntervalQ s z Defaults.checkRotationIntervalc C s\ | d j � s*| d j� rL| d j� tjkrLy t| �}|S tk
rJ Y nX ttd���dS )z�Checks that an option is an SI unit size string.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to a SizeString.
Raises:
ArgumentError
r z must be an SI-style size stringN���rZ rZ ) �isdigit�isalpha�lowerr Z
lvmSiSuffixesr rA r r0 )r1 rH r r r rJ b s zDefaults.checkSiSizec C s2 y t | �}|S tk
r Y nX ttd���dS )z�Checks that an option is an LVM-style size string.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to a SizeString.
Raises:
ArgumentError
z must be an LVM-style size stringN)r rA r r0 )r1 rH r r r rF x s zDefaults.checkSizec C s| yVt | �}|j� }tj|� s<tj| ko4tjkn rTttd�j tjtj���|S t
k
rj Y nX ttd���dS )z�Checks that an option is a valid slab size.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to a SizeString.
Raises:
ArgumentError
z*must be a power of two between {0} and {1}z must be an LVM-style size stringN) r ZtoBytesr Z isPowerOfTwor � slabSizeMin� slabSizeMaxr r0 rB rA )r1 rH �sizer r r �
checkSlabSize� s zDefaults.checkSlabSizec C s t jdd| �S )a& Checks that an option is a valid thread count, for worker thread
types requiring between 0 and 100 threads, inclusive.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to an integer.
Raises:
ArgumentError
r r )r r4 )r1 r r r �checkThreadCount0_100� s
z Defaults.checkThreadCount0_100c C s t jdd| �S )a& Checks that an option is a valid thread count, for worker thread
types requiring between 1 and 100 threads, inclusive.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value converted to an integer.
Raises:
ArgumentError
r r )r r4 )r1 r r r �checkThreadCount1_100� s
z Defaults.checkThreadCount1_100c C sL | dks| dkrdS yt j| �}t|�S tk
r: Y nX ttd���dS )z�Checks that an option is a valid UUID.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The uuid as a string.
Raises:
ArgumentError
Nr& z$must be a valid UUID or empty string)�uuidZUUID�strrA r r0 )r1 �valr r r �checkUUIDValue� s
zDefaults.checkUUIDValuec C sP d}t jd| d | �dkr0ttd�j|| ���| jd�rLttd�j| ���| S )a� Checks that an option is a valid VDO device name.
The "dmsetup create" command will accept a lot of characters that
could be problematic for udev or for running shell commands
without careful quoting. For now, we permit only alphanumerics and
a few other characters.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The device name as a string.
Raises:
ArgumentError
zA-Za-z0-9#+.:@_-z^[z]*$NzFVDO device names may only contain characters in '{0}': bad value '{1}'�-z8VDO device names may not start with '-': bad value '{0}')�re�matchr r0 rB �
startswith)r1 Z allowedCharsr r r � checkVDOName� s
zDefaults.checkVDONamec C s d S )Nr )r r r r r
s zDefaults.__init__c C s^ | dk rZt jj| �rZt j| �}tj|j�r<ttd�j| ���tj |j�rZttd�j| ���| S )z�Checks that an option does not specify an existing block device
or directory.
Arguments:
value (str): Value provided as an argument to the option.
Returns:
The value.
Raises:
ArgumentError
Nz{0} is a block devicez{0} is a directory)
r- r. �exists�stat�S_ISBLK�st_moder r0 rB �S_ISDIR)r1 Zpathstatr r r r9 s
z&Defaults._checkNotBlockFileOrDirectoryc C sV y(t |�}| | ko |kn r&|S W n tk
r< Y nX ttd�j| |���dS )aT Checks that an option is a valid integer within a desired range.
Arguments:
minValue (int): The minimum acceptable value.
maxValue (int): The maximum acceptable value.
value (str): Value provided as an argument to the option.
Returns:
The value converted to an integer.
Raises:
ArgumentError
z=must be an integer at least {0} and less than or equal to {1}N)r> rA r r0 rB )ZminValueZmaxValuer1 rC r r r r4 s zDefaults._rangeCheckNrZ )^r r r r ZNOTSETZ
ackThreadsZ
ackThreadsMaxZ
ackThreadsMinr ZenabledZactivateZbioRotationIntervalrX rW ZbioThreadOverheadMBZ
bioThreadsZ
bioThreadsMaxZ
bioThreadsMinr ZblockMapCacheSizerO rN r ZMiBZ$blockMapCacheSizeMinPerLogicalThreadZblockMapPeriodr6 r5 Zcfreqr- �getenvZconfFileZconversionUtilityDirZ compressionZ
deduplicationZ
cpuThreadsZ
cpuThreadsMaxZ
cpuThreadsMinZdisabledZ
emulate512ZhashZoneThreadsZhashZoneThreadsMaxZhashZoneThreadsMinZindexMemr@ r? rG ZlogicalThreadsZ(logicalThreadsBlockMapCacheSizeThresholdrU rT ZmaxDiscardSizerL rK Z mdRaid5ModeZphysicalThreadOverheadMBZphysicalThreadsrR rQ ZslabSizer_ r^ Z sparseIndexZudsParallelFactorrd ZvdoPhysicalBlockSizeZ vdoLogLevelZvdoLogLevelChoicesZ
vdoTargetNameZ writePolicyZwritePolicyChoices� staticmethodr2 r3 r7 r: rD rE rI rM rP rS rV rY rJ rF ra rb rc rg rl r
r9 r4 r r r r r 3 s�
" % r )r Z
__future__r r r r r& r r r r
r- ri rn rd � Exceptionr �objectr r r r r �<module> s
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists