HEX

File: //usr/lib/python3/dist-packages/cloudinit/config/__pycache__/cc_disk_setup.cpython-310.pyc
o

�Ad[��@sUdZddlZddlZddlZddlmZddlmZddlmZm	Z	ddl
mZddlm
Z
ddlmZmZdd	lmZdd
lmZe�d�Ze�d�Ze�d
�Ze�d�Ze�d�Ze�d�Ze�d�ZddiZe�e�Z dZ!ddde!egeed�gddgd�Z"ee#d<ee"�Zde$de
ded ed!e%d"dfd#d$�Z&d%d&�Z'd'd(�Z(d[d)d*�Z)d\d,d-�Z*d.d/�Z+d\d0d1�Z,d2d3�Z-d4d5�Z.				6	d]d7d8�Z/d9d:�Z0d;d<�Z1d=d>�Z2d?d@�Z3dAdB�Z4dCdD�Z5dEdF�Z6dGdH�Z7dIdJ�Z8dKdL�Z9dMdN�Z:dOdP�Z;dQdR�Z<dSdT�Z=dUdV�Z>dWdX�Z?dYdZ�Z@dS)^z1Disk Setup: Configure partitions and filesystems.�N)�Logger)�dedent)�subp�util)�Cloud)�Config)�
MetaSchema�get_meta_doc)�ALL_DISTROS)�PER_INSTANCE�sfdisk�sgdisk�lsblk�blkid�blockdev�	partprobe�wipefs�LANG�CaiThis module is able to configure simple partition tables and filesystems.

.. note::
    for more detail about configuration options for disk setup, see the disk
    setup example

.. note::
    if a swap partition is being created via ``disk_setup`` then a ``fs_entry``
    entry is also needed in order for mkswap to be run, otherwise when swap
    activation is later attempted it will fail.

For convenience, aliases can be specified for disks using the
``device_aliases`` config key, which takes a dictionary of alias: path
mappings. There are automatic aliases for ``swap`` and ``ephemeral<X>``, where
``swap`` will always refer to the active swap partition and ``ephemeral<X>``
will refer to the block device of the ephemeral image.

Disk partitioning is done using the ``disk_setup`` directive. This config
directive accepts a dictionary where each key is either a path to a block
device or an alias specified in ``device_aliases``, and each value is the
configuration options for the device. File system configuration is done using
the ``fs_setup`` directive. This config directive accepts a list of
filesystem configs.
�
cc_disk_setupz
Disk Setupz$Configure partitions and filesystemsan            device_aliases:
              my_alias: /dev/sdb
              swap_disk: /dev/sdc
            disk_setup:
              my_alias:
                table_type: gpt
                layout: [50, 50]
                overwrite: true
              swap_disk:
                table_type: gpt
                layout: [[100, 82]]
                overwrite: true
              /dev/sdd:
                table_type: mbr
                layout: true
                overwrite: true
            fs_setup:
            - label: fs1
              filesystem: ext4
              device: my_alias.1
              cmd: mkfs -t %(filesystem)s -L %(label)s %(device)s
            - label: fs2
              device: my_alias.2
              filesystem: ext4
            - label: swap
              device: swap_disk.1
              filesystem: swap
            - label: fs3
              device: /dev/sdd1
              filesystem: ext4
            mounts:
            - ["my_alias.1", "/mnt1"]
            - ["my_alias.2", "/mnt2"]
            - ["swap_disk.1", "none", "swap", "sw", "0", "0"]
            - ["/dev/sdd1", "/mnt3"]
            �
disk_setup�fs_setup)�id�name�title�description�distros�	frequency�examples�activate_by_schema_keys�metar�cfg�cloud�log�args�returncs�|�di����fdd�}|�d�}t|t�rit||�|�dt|��|��D]@\}}t|t�s9|�d|�q(z|�d�tj	t
jd|t||fd	�Wq(tyh}	zt�
t
d
|	�WYd}	~	q(d}	~	ww|�d�}
t|
t�r�|�d
t|
��t|
|�|
D]D}t|t�s�|�d|�q�z|�d�|�d�}tj	t
jd|t|fd	�Wq�ty�}	zt�
t
d|	�WYd}	~	q�d}	~	wwdSdS)z[
    See doc/examples/cloud-config-disk-setup.txt for documentation on the
    format.
    �device_aliasescs��|�}��|p
|�p
|S�N)�get�device_name_to_device)�candr�r"r&��@/usr/lib/python3/dist-packages/cloudinit/config/cc_disk_setup.py�alias_to_device|s
zhandle.<locals>.alias_to_devicerzPartitioning disks: %szInvalid disk definition for %sz!Creating new partition table/diskzCreating partition on %s)�logfunc�msg�funcr$z Failed partitioning operation
%sNrzsetting up filesystems: %sz"Invalid file system definition: %szCreating new filesystem.�devicezCreating fs for %sz%Failed during filesystem operation
%s)r(�
isinstance�dict�update_disk_setup_devices�debug�str�items�warningr�log_time�LOG�mkpart�	Exception�logexc�list�update_fs_setup_devices�mkfs)rr!r"r#r$r.r�disk�
definition�err2r,r+r-�handlessZ





���






����rEcCs�t|�D]:}||�}|dus||krq||vr!t�d||�||=||||<t||t�r4|||d<||=t�d||�qdS)Nz0Replacing %s in disk_setup for translation of %s�	_orignamez,updated disk_setup device entry '%s' to '%s')r?r;�infor3r4r6)r�tformer�origname�transformedr,r,r-r5�s*���r5cCs�|D]Q}t|t�st�d|�q|�d�}|durqt�|�\}}||�}|dur;|}t�d|||�||d<||d<|rSd|vrOt�d|||�|d|d<||d<qdS)Nz"entry in disk_setup not a dict: %sr2z%s is mapped to disk=%s part=%srF�	partitionzKPartition '%s' from dotted device name '%s' overrides 'partition' key in %s�
_partition)r3r4r;r9r(r�expand_dotted_devnamer6)rrHrCrI�dev�part�tformedr,r,r-r@�s8

����r@ccsB�t�|�}|r||d�}dd�|D�D]	\}}||fVqdS)zd
    Returns the key/value pairs of output sent as string
    like:  FOO='BAR' HOME='127.0.0.1'
    NcSsg|]}|�d��qS)�=)�split��.0�xr,r,r-�
<listcomp>�sz"value_splitter.<locals>.<listcomp>)�shlexrR)�values�start�_values�key�valuer,r,r-�value_splitter�s�
�r]Fc
cs��tddd|g}|r|�d�d}z	t�|�\}}Wnty/}z	td||f�|�d}~wwdd�|����D�}|D]}ddddd	�}t|�D]
\}	}
|
||	��<qJ|Vq=dS)
a�
    Enumerate the elements of a child device.

    Parameters:
        device: the kernel device name
        nodeps <BOOL>: don't enumerate children devices

    Return a dict describing the disk:
        type: the entry type, i.e disk or part
        fstype: the filesystem type, if it exists
        label: file system label, if it exists
        name: the device name, i.e. sda
    z--pairsz--outputzNAME,TYPE,FSTYPE,LABELz--nodepsN�"Failed during disk check for %s
%scSs g|]}t|���dkr|�qS)r)�lenrRrSr,r,r-rVs z"enumerate_disk.<locals>.<listcomp>)r�type�fstype�label)�	LSBLK_CMD�appendrr=�strip�
splitlinesr]�lower)r2�nodeps�	lsblk_cmdrG�_errrD�partsrO�dr[r\r,r,r-�enumerate_disk�s>��

������rmcCs.t|dd�D]}d|vr|d��SqdS)z@
    Return the device type of the device by calling lsblk.
    T)rhr`N)rmrg)r2rlr,r,r-�device_type)s
�rncCsVd}zt|�}Wntyt�d|�YdSw|r!|dkr!dS|s)|dkr)dSdS)z0
    Check if the device is a valid device.
    �zQuery against device %s failedFrOTrB)rnr=r;r9)rrK�d_typer,r,r-�is_device_valid4s�rqc

Cs�d\}}}}tdd|g}z
tj|ddgd�\}}Wnty.}z	td||f�|�d}~ww|r^t|���d	kr^t|d	d
�D]\}}	|��dkrL|	}q?|��dkrU|	}q?|��d
kr]|	}q?|||fS)z�
    Check if the device has a filesystem on it

    Output of blkid is generally something like:
    /dev/sda: LABEL="Backup500G" UUID="..." TYPE="ext4"

    Return values are device, label, type, uuid
    )NNNNz-cz	/dev/nullr�)�rcsr^N�)rYrbr`�uuid)�	BLKID_CMDrr=r_rfr]rg)
r2�outrb�fs_typeru�	blkid_cmdrjrDr[r\r,r,r-�check_fsFs.	
�����
rzcCst|�\}}}|S)z7
    Returns true if the device has a file system.
    )rz)r2�_rxr,r,r-�
is_filesystemfsr|TcCs�|durd}|sddg}d}t|�D]W}|d|kr(|dur(d|ddfS|d|krB|r6|d	|ks8|sBd|dd
fS|d|vri|ddksR|drTd
}|ddkr[q|dsid|ddfSq|sp|dfSt�d�d
S)a
    Find a device that is either matches the spec, or the first

    The return is value is (<device>, <bool>) where the device is the
    device to use and the bool is whether the device matches the
    fs_type and label.

    Note: This works with GPT partition tables!
    NrorBrOFra�/dev/%srrbTr`z5Failed to find device during available device search.)NF)rmr;r9)r2rxrb�
valid_targets�label_match�
replace_fs�raw_device_usedrlr,r,r-�find_device_nodens8�
���
r�cCs2ttt|���dkrdSt|�\}}}|rdSdS)z�
    Check if the device is currently used. Returns true if the device
    has either a file system or a partition entry
    is no filesystem found on the disk.
    rtTF)r_r?rmrz)r2r{�check_fstyper,r,r-�is_disk_used�s	r�c
Cshzt�td|g�\}}t�td|g�\}}Wnty+}z	td||f�|�d}~wwt|�t|�S)Nz--getsize64z--getsszFailed to get %s size
%s)r�
BLKDEV_CMDr=�int)r2�
size_in_bytesr{�sector_sizerDr,r,r-�get_hdd_size�s��r�c
Cs�t|�td|g}z
tj|d|d�\}}Wnty+}z	td||f�|�d}~wwg}|��D]C}|��}t|�dkr?q2||dvru|d��dvrNq2d}	tt	d	t|��d
d�D]}
||
�
�ro||
dkro||
}	nq[|�|	�q2|S)
z�
    Returns true if the partition layout matches the one on the disk

    Layout should be a list of values. At this time, this only
    verifies that the number of partitions and their labels is correct.
    z-l�%s
��data�(Error running partition command on %s
%sNr���)�extended�emptyrtT)�reverse�/)�read_parttbl�
SFDISK_CMDrr=rfrRr_rg�sorted�range�isdigitrd)r2�layout�prt_cmdrwrjrD�found_layout�line�_line�
type_labelrUr,r,r-�check_partition_mbr_layout�s:

�����
�r�c
Cs�td|g}ztj|td�\}}Wnty%}z	td||f�|�d}~wwt|���}|D]}|���d�r9nq.dd�|D�}g}	|D]}
t|
�dkrX|
�	d�rX|
d	d
�}
|	�
|
�qE|	S)Nz-p)�
update_envr��NumbercSsg|]
}|����d�qS)�)rerR)rTr�r,r,r-rV	sz.check_partition_gpt_layout.<locals>.<listcomp>��00rrr)�
SGDISK_CMDr�
LANG_C_ENVr=�iterrfre�
startswithr_�endswithrd)r2r�r�rwrjrD�	out_linesr��codes�cleaned�coder,r,r-�check_partition_gpt_layout�s.

�����r�cCs�d|kr
t||�}nd|krt||�}ntd��t�d||||�t|t�r2|r0t|�dkr0dSdSt|�t|�krcdd	�|D�}t�d
||�t||�D]\}}|dur`t	|�t	|�kr`dSqMdSdS)z�
    See if the partition lay out matches.

    This is future a future proofing function. In order
    to add support for other disk layout schemes, add a
    function called check_partition_%s_layout
    �gpt�mbr�Unable to determine table typez6called check_partition_%s_layout(%s, %s), returned: %srtTFcSs*g|]}t|ttf�rt|d�nd�qS)rtN)r3�tupler?r7rSr,r,r-rV4s�z*check_partition_layout.<locals>.<listcomp>zLayout types=%s. Found types=%sN)
r�r�r=r;r6r3�boolr_�zipr7)�
table_typer2r�r��layout_types�itype�ftyper,r,r-�check_partition_layouts:�
���r�c
Cst|t�st|t�rdSt|�dkrt|t�st|t�s td��t|�}|dkr,td��g}d}|D]@}d}|}|d7}t|t�rQt|�dkrMtd	|��|\}}tt|�t|�d
�}||kri|�d|�q2|�d||f�q2d
�|�}	t|�dkr�td|	��|	S)a@
    Calculate the layout of the partition table. Partition sizes
    are defined as percentage values or a tuple of percentage and
    partition type.

    For example:
        [ 33, [66: 82] ]

    Defines the first partition to be a size of 1/3 the disk,
    while the remaining 2/3's will be of type Linux Swap.
    z,,83rzPartition layout is invalidr�z$Only simply partitioning is allowed.�Srtrr�%Partition was incorrectly defined: %s�dz,,%sz,%s,%s�
z-Calculated partition definition is too big
%s)	r3r?r�r_r=r��floatrd�join)
�sizer��
last_part_num�part_definition�part_numrO�	part_type�percent�	part_size�sfdisk_definitionr,r,r-�get_partition_mbr_layoutBs>
�

��r�cCs�t|t�rdddgfgSg}|D]4}t|t�r(t|�dkr#td|��|\}}n|}d}tt|�t|�d�}|�|dd�|�gf�qd|ddd<|S)Nrrrr�r�z+{}r�)	r3r�r?r_r=r�r�rd�format)r�r��partition_specsrKr��partition_typer�r,r,r-�get_partition_gpt_layoutys 

�
r�cCsvd}d}d}t|d��"}|�||�|�|tj�|�||�|��Wd�n1s0wYt|�dS)N�izrb+)�open�write�seek�os�SEEK_END�flushr�)r2�null�	start_len�end_len�fpr,r,r-�purge_disk_ptable�s
�r�cCs�t|�D]6}|ddvr:tdd|dg}zt�d|d�t�|�Wqty9}z	td|d�|�d}~wwqt|�dS)	z'
    Remove parition table entries
    r`)rB�cryptz--allr}rzPurging filesystem on /dev/%szFailed FS purge of /dev/%sN)rm�
WIPEFS_CMDr;rGrr=r�)r2rl�
wipefs_cmdrDr,r,r-�
purge_disk�s 
�����
r�cCs,d|kr	t||�Sd|krt||�Std��)z�
    Call the appropriate function for creating the table
    definition. Returns the table definition

    This is a future proofing function. To add support for
    other layouts, simply add a "get_partition_%s_layout"
    function.
    r�r�r�)r�r�r=)r�r�r�r,r,r-�get_partition_layout�s
	

r�c
Csttdur	t|g}ntd|g}t��zt�|�Wnty3}zt�td|�WYd}~nd}~wwt��dS)zq
    `Partprobe` is preferred over `blkdev` since it is more reliably
    able to probe the partition table.
    Nz
--rereadptz%Failed reading the partition table %s)�
PARTPROBE_CMDr�r�udevadm_settlerr=r>r;)r2�	probe_cmdrDr,r,r-r��s

��r�c
CsXtd|g}ztj|d|d�Wnty%}z	td||f�|�d}~wwt|�dS)zV
    Break out of mbr partition to allow for future partition
    types, i.e. gpt
    z--forcer�r�z Failed to partition device %s
%sN)r�rr=r�)r2r�r�rDr,r,r-�exec_mkpart_mbr�s

����r�c
Cs�zBt�td|g�t|�D]3\}\}\}}|d7}t�tdd�|||�|g�|dur@t|��dd�}t�tdd�||�|g�q
WntyPt�d	|��wt	|�dS)
Nz-Zrtz-nz{}:{}:{}r��0z-tz{}:{}zFailed to partition device %s)
rr��	enumerater�r7�ljustr=r;r9r�)r2r��indexr�rY�end�pinputr,r,r-�exec_mkpart_gpt�s.������r�cCs8tj�|�st��tj�|�std|��t��dS)z?Assert that device exists and settle so it is fully recognized.zBDevice %s did not exist and was not created with a udevadm settle.N)r��path�existsrr��RuntimeError�r2r,r,r-�assert_and_settle_devices��r�cCs�t|�tj�|�}t�d|�|�dd�}|�dd�}|�dd�}t�d�t|t�r.|r0|s7t�d�d	St�d
|�t	|�sIt
dj|d���t|t�r_|�
�d
kr_t�d�t|�d	St�d�t|||�rqt�d�dSt�d�|s�t|�s�t|�r�t�d|�d	St�d|�t|�}t�d�t|||�}t�d|�t�d|�d|kr�t||�nd|kr�t||�nt
d��t�d|�d	S)a�
    Creates the partition table.

    Parameters:
        definition: dictionary describing how to create the partition.

            The following are supported values in the dict:
                overwrite: Should the partition table be created regardless
                            of any pre-exisiting data?
                layout: the layout of the partition table
                table_type: Which partition table to use, defaults to MBR
                device: the device to work on.
    z!Checking values for %s definition�	overwriteFr�r�r�z Checking against default devicesz)Device is not to be partitioned, skippingNz'Checking if device %s is a valid devicez%Device {device} is not a disk device!r��removez,Instructed to remove partition table entriesz!Checking if device layout matchesz"Device partitioning layout matchesTz'Checking if device is safe to partitionz-Skipping partitioning on configured device %szChecking for device size of %szCalculating partition layoutz   Layout is: %szCreating partition table on %sr�r�zPartition table created for %s)r�r�r��realpathr;r6r(r3r�rqr=r�r7rgr�r�r�r|r�r�r�r�)r2rCr�r�r��device_sizer�r,r,r-r<sN


�




r<cCsDdddddd�}d|��vrd}|��|vr||St�d|�dS)z9
    A force flag might be -F or -F, this look it up
    z-Fz-f)�ext�btrfs�xfs�reiserfs�swapr�zForce flag for %s is unknown.ro)rgr;r9)�fs�flagsr,r,r-�lookup_force_flagYs�r�c
Csr|�d�}|�d�}t|�dd��}|�d�}|�dg�}|�dg�}|�dd	�}|�d
d	�}t|�tj�|�}t�d|�|rE|��r�|��rVd||f}t�d
||�t�d|�t	|�\}	}
}t�d||	|
�|	|kr�|
|kr�t�d|�|s�t�d|�dSt�
d|�nmt�d|�nf|r�t|���dvr�|}t�d|�d}
|��dkr�d	}
t||||
|d�\}}t�d||�|r�t�d�dS|s�|r�|r�t�d|�|s�t�d|�dSn|r�t|���dkr�t�d|�nt�d�dSt�d |||�|�s
t�
d!|�dS|�s|�st
d"j|d#���d	}|�r<|d|||d$�}d}|�r2t�
d%|�|�r;t�
d&|�nMt�d'|�}|�sMt�d(|�}|�sYt�
d)||�dS|g}|�rf|�d*|g�|�spt|�d+k�r|t|�}|�r||�|�|�r�|�|�|�|�t�d,||�t�d-t|��z
tj||d.�WdSt
�y�}z	t
d/||f�|�d}~ww)0a�
    Create a file system on the device.

        label: defines the label to use on the device
        fs_cfg: defines how the filesystem is to look
            The following values are required generally:
                device: which device or cloud defined default_device
                filesystem: which file system type
                overwrite: indiscriminately create the file system
                partition: when device does not define a partition,
                            setting this to a number will mean
                            device + partition. When set to 'auto', the
                            first free device or the first device which
                            matches both label and type will be used.

                            'any' means the first filesystem that matches
                            on the device.

            When 'cmd' is provided then no other parameter is required.
    rbr2rK�any�
filesystem�cmd�
extra_optsr�Fr�z#Checking %s against default devicesz%s%sz%Manual request of partition %s for %szChecking device %sz0Device '%s' has check_label='%s' check_fstype=%sz Existing file system found at %sz"Device %s has required file systemNzDestroying filesystem on %sz"Device %s is cleared for formating)�autor�z,Identifying device to create %s filesytem onT)rxrbrr�z(Automatic device for %s identified as %sz+Found filesystem match, skipping formating.z*Replacing file system on %s as instructed.zENo device available that matches request. Skipping fs creation for %s�nonez.Using the raw device to place filesystem %s onz(Error in device identification handling.z;File system type '%s' with label '%s' will be created on %szDevice is not known: %szENo way to create filesystem '{label}'. fs_type or fs_cmd must be set.)rb)rbr�r2z8fs_setup:overwrite ignored because cmd was specified: %sz9fs_setup:extra_opts ignored because cmd was specified: %szmkfs.%szmk%sz.Cannot create fstype '%s'.  No mkfs.%s commandz-LrBzCreating file system %s on %sz     Using cmd: %s)�shellzFailed to exec of '%s':
%s)r(r7r�r�r�r�r;r6r�rzr9rgr�r=r�r�which�extendrnr�rd)�fs_cfgrbr2rKrx�fs_cmd�fs_opts�
fs_replacer��check_labelr�r{�odevicer�reuser��mkfs_cmd�
force_flagrDr,r,r-rAos�


��
�
��
��������


��rAr')F)NNNTN)A�__doc__�loggingr�rWr�textwrapr�	cloudinitrr�cloudinit.cloudr�cloudinit.configr�cloudinit.config.schemarr	�cloudinit.distrosr
�cloudinit.settingsrrr�r�rcrvr�r�r�r��	getLogger�__name__r;�MODULE_DESCRIPTIONr �__annotations__r7r?rEr5r@r]rmrnrqrzr|r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r<r�rAr,r,r,r-�<module>s�







��)�3�����
�7
&

2
 

�8
').7G