grthtrhthjhtyjytjytkergtrhtrjytjerhrfh4:24 29/09/2026a dtd/?@stdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl Z e Z Gddde ZGdddeZGdd d eZGd d d eZd d ZddZddZddZddZeZddZddZeZddZddZddZd d!Zd"d#Zd$d%Z d&d'Z!d(d)Z"d*d+Z#d,d-Z$e d.d/Z%da Provides various utility functions. This file is part of RTSLib. Copyright (c) 2011-2013 by Datera, Inc Copyright (c) 2011-2014 by Red Hat, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. N)contextmanagerc@seZdZdZdS) RTSLibErrorz Generic rtslib error. N__name__ __module__ __qualname____doc__r r 0/usr/lib/python3.9/site-packages/rtslib/utils.pyr"src@seZdZdZdS)RTSLibALUANotSupportedz( Backend does not support ALUA. Nrr r r r r (sr c@seZdZdZdS)RTSLibBrokenLinkzC Broken link in configfs, i.e. missing LUN storage object. Nrr r r r r .sr c@seZdZdZdS)RTSLibNotInCFSz The underlying configfs object does not exist. Happens when calling methods of an object that is instantiated but have been deleted from congifs, or when trying to lookup an object that does not exist. Nrr r r r r 4sr cCs<t|d}|t|Wdn1s.0YdS)a This function writes a string to a file, and takes care of opening it and closing it. If the file does not exist, it will be created. >>> from rtslib.utils import * >>> fwrite("/tmp/test", "hello") >>> fread("/tmp/test") 'hello' @param path: The file to write to. @type path: string @param string: The string to write to the file. @type string: string wN)openwritestr)pathstringfile_fdr r r fwrite=s rcCs:t|d}|WdS1s,0YdS)a  This function reads the contents of a file. It takes care of opening and closing it. >>> from rtslib.utils import * >>> fwrite("/tmp/test", "hello") >>> fread("/tmp/test") 'hello' >>> fread("/tmp/notexistingfile") # doctest: +ELLIPSIS Traceback (most recent call last): ... IOError: [Errno 2] No such file or directory: '/tmp/notexistingfile' @param path: The path to the file to read from. @type path: string @return: A string containing the file's contents. rN)rreadstrip)rrr r r freadQs rcCstjt|}zLtjt|}|jdkrFt |tj tj Btj B}nt |tj tj B}Wnt ypYdS0t|dSdS)a< This function will check if the device or file referenced by path is already mounted or used as a storage object backend. It works by trying to open the path with O_EXCL flag, which will fail if someone else already did. Note that the file is closed before the function returns, so this does not guaranteed the device will still be available after the check. @param path: path to the file of device to check @type path: string @return: A boolean, True is we cannot get exclusive descriptor on the path, False if we can. Z scsi_genericTFN)osrrealpathrpyudevDevicefrom_device_file_CONTEXT subsystemrO_EXCLO_NDELAYO_RDWROSErrorclose)rdevicerr r r is_dev_in_usegs    r'c Csz|j}z|d}Wntttfy.YdS0|ddkrD|jj}z|d}WntttfylYdS0|d|S)z @param device: the device @type device: pyudev.Device @return: the size in logical blocks, 0 if none found @rtype: int sizerZDEVTYPE partitionzqueue/logical_block_sizei) attributesasintKeyErrorUnicodeDecodeError ValueErrorparent)r&r*Z sect_sizeZlogical_block_sizer r r _get_size_for_devs r0cCs"tjttjt|}t|S)z @param path: The path to a block device @type path: string @return: The size in logical blocks of the device @raises: DeviceNotFoundError if corresponding device not found @raises: EnvironmentError, ValueError in some situations ) rrrrrrrrr0)rr&r r r get_size_for_blk_devsr1cCsdd}|dd}z ||WStjytd|}|r~|d}|ddkrn|d rn|d d}||YSYn0d S) z @param name: a kernel disk name, as found in /proc/partitions @type name: string @return: The size in logical blocks of a disk-type block device. @raises: DeviceNotFoundError cSstjtd|}t|S)zp :param str name: name of block device :raises DeviceNotFoundError: if device not found block)rr from_namerr0)namer&r r r get_sizesz(get_size_for_disk_name..get_size/!z^([a-z0-9_\-!]+?)(\d+)$rpN)replacerDeviceNotFoundErrorresearchgroupsisdigitgroup)r4r5mZdiskr r r get_size_for_disk_names      rCc Cstztjt|}Wntjttfy.YdS0|jdkr>dS|j}d}z| d}Wnt t tfynYn0|S)a This function returns a block device's type. Example: 0 is TYPE_DISK If no match is found, None is returned. >>> from rtslib.utils import * >>> get_blockdev_type("/dev/sda") 0 >>> get_blockdev_type("/dev/sr0") 5 >>> get_blockdev_type("/dev/scd0") 5 >>> get_blockdev_type("/dev/nodevicehere") is None True @param path: path to the block device @type path: string @return: An int for the block device type, or None if not a block device. Nr2rz device/type) rrrrr<EnvironmentErrorr.r r*r+r,r-)rr&r*Z disk_typer r r get_blockdev_types rEcCsXz>tj|}tjt|}|jdd}dd|j dDWSt dYn0dS)a9 This function returns the SCSI ID in H:C:T:L form for the block device being mapped to the udev path specified. If no match is found, None is returned. >>> import rtslib.utils as utils >>> utils.convert_scsi_path_to_hctl('/dev/scd0') (2, 0, 0, 0) >>> utils.convert_scsi_path_to_hctl('/dev/sr0') (2, 0, 0, 0) >>> utils.convert_scsi_path_to_hctl('/dev/sda') (3, 0, 0, 0) >>> utils.convert_scsi_path_to_hctl('/dev/sda1') >>> utils.convert_scsi_path_to_hctl('/dev/sdb') (3, 0, 1, 0) >>> utils.convert_scsi_path_to_hctl('/dev/sdc') (3, 0, 2, 0) @param path: The udev path to the SCSI block device. @type path: string @return: An (host, controller, target, lun) tuple of integer values representing the SCSI ID of the device, or raise RTSLibError. scsi)r cSsg|] }t|qSr )int).0datar r r z-convert_scsi_path_to_hctl..:z#Could not convert scsi path to hctlN) rrrrrrrZ find_parentZsys_namesplitr)rr&r/r r r convert_scsi_path_to_hctls  rNcCsz$t|}t|}t|}t|}Wnty>tdYn0t|t|t|t|g}ztjtdd|}Wntj ytdYn0tj d|d}t dd|Dd }|d krtd|S) a This function returns a udev path pointing to the block device being mapped to the SCSI device that has the provided H:C:T:L. >>> import rtslib.utils as utils >>> utils.convert_scsi_hctl_to_path(0,0,0,0) '' >>> utils.convert_scsi_hctl_to_path(2,0,0,0) # doctest: +ELLIPSIS '/dev/s...0' >>> utils.convert_scsi_hctl_to_path(3,0,2,0) '/dev/sdc' @param host: The SCSI host id. @type host: int @param controller: The SCSI controller id. @type controller: int @param target: The SCSI target id. @type target: int @param lun: The SCSI Logical Unit Number. @type lun: int @return: A string for the canonical path to the device, or raise RTSLibError. z?The host, controller, target and lun parameter must be integersrFrLz!Could not find path for SCSI hctlr2)r r/css|] }|jVqdSN)Z device_node)rHdevr r r ;rKz,convert_scsi_hctl_to_path..N) rGr.rrrrr3rjoinr<Z list_devicesnext)hostZ controllertargetZlunZhctlZ scsi_deviceZdevicesrr r r convert_scsi_hctl_to_paths,   rWcCs|}|dkrttS|dkr0ttS|dkrtdddd}t ddd}d ||f}| }d ttd d }d ||fS|dkrdtj dd S|dkrdtj dd St d|d S)a  Generates a random WWN of the specified type: - unit_serial: T10 WWN Unit Serial. - iqn: iSCSI IQN - naa: SAS NAA address @param wwn_type: The WWN address type. @type wwn_type: str @returns: A string containing the WWN. free unit_serialiqn.r_rRz!iqn.2003-01.org.linux-iscsi.%s.%szsn.%sNz%s:%snaaz naa.5001405ieuiz eui.001405izUnknown WWN type: %s) lowerruuidZuuid4socketZ gethostnamerMr;runamerhexr.)wwn_typeZ localnameZ localarchprefixserialr r r generate_wwn@s"      rics$dfddtdtdDS)z5 helper function to add colons every 2 chars rLc3s|]}||dVqdS)Nr )rHirr r rQerKzcolonize..rrj)rSrangelenrlr rlr colonizeasrocCstt|}|dvrp|dr.|dd}|dd}|dd}|dsp|d sp|d sp|d |}|S) zh Some wwns may have alternate text representations. Adjust to our preferred representation. )r_r`ib0xrjN-rRrLznaa.zeui.zib.r[)rrra startswithr;)rfwwnr r r _cleanse_wwngs     rucCslddddddddddddd}|D]"}t||}|||}|r.qdq.td d |||fS) z Take a WWN as given by the user and convert it to a standard text representation. Returns (normalized_wwn, wwn_type), or exception if invalid wwn. cSsdS)NTr rtr r r rKznormalize_wwn..cSs(td|o&td| o&td| S)Nz iqn\.[0-9]{4}-[0-1][0-9]\..*\..* r\)r=matchr>rvr r r rws  cSs td|S)Nz naa\.[125c-fC-F][0-9a-fA-F]{15}$r=ryrvr r r rwrKcSs td|S)Nzeui\.[0-9a-f]{16}$rzrvr r r rwrKcSs td|S)Nzib\.[0-9a-f]{32}$rzrvr r r rwrKcSs td|S)Nz3[0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$rzrvr r r rws)rXrZr_r`rprYzWWN not valid as: %sz, )rurrS)Z wwn_typesrtZwwn_testrfZ clean_wwnZ found_typer r r normalize_wwnzs   r{cCsddtddDS)z2 List all currently loaded kernel modules cSsg|]}|r|ddqS)rxr)rM)rHliner r r rJsz.list_loaded_kernel_modules..z /proc/modules )rrMr r r r list_loaded_kernel_moduless r~cCs|tvrdSz ddl}WnJtydtjd|ftjtjd}|\}}|jdkr^t|YdS0z| |Wn"|j j ytd|Yn0dS)z Load the specified kernel module if needed. @param module: The name of the kernel module to be loaded. @type module: str NrmodprobestdoutstderrzCould not load module: %s) r~kmod ImportError subprocessPopenPIPE communicate returncoderZKmodrerrorZ KmodError)modulerprocess stdoutdata stderrdatar r r rs"      rcCsVtjdsRd}tj|tjtjd}|\}}|jdkrRtjdsRt ddS)Nz/sys/kernel/configz)mount -t configfs none /sys/kernel/configrrzCannot mount configfs) rrismountrrrMrrrr)Zcmdlinerrrr r r mount_configfss   rcCs|D]}||vr||=qdSrOr )ditemsitemr r r dict_removesrcgs"z dVWn|yYn0dSrOr ) exceptionsr r r ignoreds  rFcCsL|d|j|f}z t|}Wn|s0YdS0|dkrDdS|SdS)N%s/%sNULLrR) _check_selfrr)self attributeignorervaluer r r _get_auth_attrs rcCsx|d|j|f}|}|dkr.tdt|dkrBtd|dkrNd}zt|d|Wn|snYn0dS)Nrrz'NULL' is not a permitted valuez'Value longer than maximum length of 255rRz%s)rrrrrnr)rrrrrr r r _set_auth_attrs rc CsZt|D]J\}}z|||Wq tyR}z|t|WYd}~q d}~00q dSrO)six iteritemsZ set_attributerr)objZ attr_dicterr_funcr4rer r r set_attributess rc CsZt|D]J\}}z|||Wq tyR}z|t|WYd}~q d}~00q dSrO)rrZ set_parameterrr)rZ param_dictrr4rrr r r set_parameterss rcCsddl}|dS)zRun the doctestsrN)doctestZtestmod)rr r r _test sr__main__)F)F),rrr=rrcstatrrb contextlibrrZContextr Exceptionrr r r rrr'r0r1Zget_block_sizerCrEZget_block_typerNrWrirorur{r~rrrrrrrrrrr r r r sT   %% 0!