~~SNdZddlZddlZddlZddlZddlZddlZddlZddlm Z eje Z Gdde ZGdde ZGd d eZd Zd Zd ZGddeZdZej.eZdZej.eZdZdZdZGddeZdZy)a This module implements python implements a way to get file block. Two methods are supported - the FIEMAP ioctl and the 'SEEK_HOLE / SEEK_DATA' features of the file seek syscall. The former is implemented by the 'FilemapFiemap' class, the latter is implemented by the 'FilemapSeek' class. Both classes provide the same API. The 'filemap' function automatically selects which class can be used and returns an instance of the class. N) BmapHelpersceZdZdZy) ErrorNotSuppz An exception of this type is raised when the 'FIEMAP' or 'SEEK_HOLE' feature is not supported either by the kernel or the file-system. N__name__ __module__ __qualname____doc__5/usr/lib/python3.12/site-packages/bmaptool/Filemap.pyrr*s   r rceZdZdZy)Errorz;A class for all the other exceptions raised by this module.Nrr r rrr3sEr rc:eZdZdZdZdZdZdZdZdZ dZ y ) _FilemapBasez This is a base class for a couple of other classes in this module. This class simply performs the common parts of the initialization process: opens the image file, gets its size, etc. c2d|_t|dr||_|j|_n||_|j  t j|jjj|_ tj|j|_|j|jzdz |jz|_ |jj# t j$|jjftj*|js;tj,|j}td |jd |d t.j1d|jzt.j1d|j|j |jfzy#t$r*}td|jjd|d}~wwxYw#t$r }td|jd|d}~wwxYw#t$r }td|jd|d}~wwxYw#t&$r+}td |jd|j(d d}~wwxYw)z Initialize a class instance. The 'image' argument is full path to the file or file object to operate on. Ffilenoz#cannot get information about file '': Nzcannot get block size for 'rzcannot flush image file 'zcannot synchronize image file ' z(image file on incompatible file system 'z': 'z': see docs for fixzopened image "%s"z-block size %d, blocks count %d, image size %d)_f_image_needs_closehasattr_f_imagename _image_path_open_image_fileosfstatrst_size image_sizeIOErrorrrget_block_size block_size blocks_cntflushfsyncOSErrorstrerroris_compatible_file_systemget_file_system_type_logdebug)selfimageerrfstypes r__init__z_FilemapBase.__init__@s# %*! 5( #!DM$zzD $D   ! ! #  hht}}';';'=>FFDO  X)88GDO ??T__N>NPSTU U V  ##S\\3  s`r ctd)a This method has has to be implemented by child classes. This is a generator which yields ranges of mapped blocks in the file. The ranges are tuples of 2 elements: [first, last], where 'first' is the first mapped block and 'last' is the last mapped block. The ranges are yielded for the area of the file of size 'count' blocks, starting from block 'start'. r9r:r-startcounts rget_mapped_rangesz_FilemapBase.get_mapped_rangess344r ctd)z This method has has to be implemented by child classes. Just like 'get_mapped_ranges()', but yields unmapped block ranges instead (holes). r9r:rBs rget_unmapped_rangesz _FilemapBase.get_unmapped_rangesr>r N) rr r r r1r4rr=r@rErGr r rrr9s+ 5 n" )55 55r rc tj|j||S#t$rP}|jtj k(rYd}~y|jtj k(r tdd}~wwxYw)a]This is a helper function which invokes 'os.lseek' for file object 'file_obj' and with specified 'offset' and 'whence'. The 'whence' argument is supposed to be either '_SEEK_DATA' or '_SEEK_HOLE'. When there is no more data or hole starting from 'offset', this function returns '-1'. Otherwise the data or hole position is returned.NzFthe kernel or file-system does not support "SEEK_HOLE" and "SEEK_DATA")rlseekrr'errnoENXIOEINVALr)file_objoffsetwhencer/s r_lseekrSsm xx)66::   99 # YY%,, &.   s$' BA;)A;;Bc:eZdZdZdZdZdZdZdZdZ dZ y ) FilemapSeekz This class uses the 'SEEK_HOLE' and 'SEEK_DATA' to find file block mapping. Unfortunately, the current implementation requires the caller to have write access to the image file. cztj||tjd|j y)5Refer the '_FilemapBase' class for the documentation.zFilemapSeek: initializingN)rr1r+r,_probe_seek_holer-r.s rr1zFilemapSeek.__init__s- dE* ./ r ctjj|j} t j d|} tj|j|jt|dt}|dk7r#tjd|ztd |jy#t $r}td|d|d}~wwxYw#t $r}td|d|d}~wwxYw) af Check whether the system implements 'SEEK_HOLE' and 'SEEK_DATA'. Unfortunately, there seems to be no clean way for detecting this, because often the system just fakes them by just assuming that all files are fully mapped, so 'SEEK_HOLE' always returns EOF and 'SEEK_DATA' always returns the requested offset. I could not invent a better way of detecting the fake 'SEEK_HOLE' implementation than just to create a temporary file in the same directory where the image file resides. It would be nice to change this to something better. zw+)dirzcannot create a temporary in "z": Nz#cannot truncate temporary file in "rzlseek(0, SEEK_HOLE) returned %dzdthe file-system does not support "SEEK_HOLE" and "SEEK_DATA" but only provides a stub implementation)rpathdirnamertempfile TemporaryFiler'r ftruncaterr#rS _SEEK_HOLEr+r,r3)r- directorytmp_objr/offss rrXzFilemapSeek._probe_seek_holesGGOOD$4$45  ,,TyAG   LL)4?? ; gq*- 19 JJ84? @1   / ;DcJ   @I3O  s/B;.C; CCC C<&C77C<ct|j||jzt}|dk(rd}n||jz|k(}tj d||fz|S)rWrKFz+FilemapSeek: block_is_mapped(%d) returns %s)rSrr# _SEEK_DATAr+r,)r-r<rdresults rr=zFilemapSeek.block_is_mappedsWdmmUT__%>%9:  Qr c .|jdk7r.|dks||jk\rtd||jfztjt|j d||j z||j ztd|jd  tj|jt|j dtj*t|j dt,S#t$r}|jtjk(r"d}t j#|t%||jtj&k(r"d}t j#|t%|td|j(d|d}~wwxYw) a; Invoke the FIEMAP ioctl for 'count' blocks of the file starting from block number 'block'. The full result of the operation is stored in 'self._buf' on exit. Returns the unpacked 'struct fiemap' data structure in form of a python list (just like 'struct.upack()'). rz-bad block number %d, should be within [0, %d]rzCFilemapFiemap: the FIEMAP ioctl is not supported by the file-systemz>FilemapFiemap: the FIEMAP ioctl is not supported by the kernelzthe FIEMAP ioctl failed for 'rN)r$rstruct pack_into_FIEMAP_FORMATrr#_FIEMAP_FLAG_SYNCr~fcntlioctlr _FIEMAP_IOCTLr!rM EOPNOTSUPPr+r,rENOTTYrunpackr|)r-r<rDr/errstrs r_invoke_fiemapzFilemapFiemap._invoke_fiemapzs[ ??a UQY%4??2J?$//*+    II DOO # DOO #   # #    KK }dii C*}}^TYY} -EFF) yyE,,,) 6""6**yyELL(W 6""6**:>:J:JCP ! s0C-- F6BFFcz|j|d}t|d}tjd||fz|S)rWrrHz-FilemapFiemap: block_is_mapped(%d) returns %s)rboolr+r,)r-r< struct_fiemaprgs rr=zFilemapFiemap.block_is_mappeds@++E15 mA&' BeV_TU r c&|j| Srirjr;s rr@zFilemapFiemap.block_is_unmappedrkr c~tt|zz}tjt|j ||tzS)z Unpack a 'struct fiemap_extent' structure object number 'index' from the internal 'self._buf' buffer. )r|r}rr_FIEMAP_EXTENT_FORMATr)r-indexrQs r_unpack_fiemap_extentz#FilemapFiemap._unpack_fiemap_extents;  3e ;;}} !499Vf?R6R#S  r c#K|}|||zkr|j||}|d}|dk(ryd}||kr|j|}|d}||jz} |d} | |jz} ||jzdk(sJ| |jzdk(sJ| ||zdz kDryt| |} t | | z||zdz } | | f|dz }||kr  z}|||zkryyw)aJ Implements most the functionality for the 'get_mapped_ranges()' generator: invokes the FIEMAP ioctl, walks through the mapped extents and yields mapped block ranges. However, the ranges may be consecutive (e.g., (1, 100), (100, 200)) and 'get_mapped_ranges()' simply merges them. rHrNr)rrr#maxmin)r-rCrDr<rmapped_extentsextent fiemap_extent extent_start extent_block extent_len extent_countfirstlasts r_do_get_mapped_rangesz#FilemapFiemap._do_get_mapped_rangess1eem# //u=M*1-N"F>) $ : :6 B  -Q/ +t> *1- )T__< $doo5:::!DOO3q888%%-!"33L%0<,6 FJdm#! />)2!</EEeem#sC C  C C c#`Ktjd||||zdz fz|j||} t|\}}|D]4\}}||dz k(r|}tjd||fz||f||}}6tjd||fz||fy#t$rYywxYww)rWz-FilemapFiemap: get_mapped_ranges(%d, %d(%d))rN&FilemapFiemap: yielding range (%d, %d))r+r,rnext StopIteration)r-rCrDiterator first_prev last_prevrrs rrEzFilemapFiemap.get_mapped_rangess ;eUU]Q./ 0 --eU; $(N !J $KE4EAI%  < I?VV"9--(-tI $ ;z9>UUV9%%   s)4B.BAB. B+(B.*B++B.c#PKtjd||||zdz fz|}|j||D]5\}}||kDr&tjd||dz fz||dz f|dz}7|||zkr-tjd|||zdz fz|||zdz fyyw)rWz/FilemapFiemap: get_unmapped_ranges(%d, %d(%d))rrN)r+r,r)r-rCrD hole_firstrrs rrGz!FilemapFiemap.get_unmapped_rangess =eUU]Q./ 0  55eUCKE4z! < ETUI?VV"519--JD  % JJ8uu}q012 uu}q01 1 &sB$B&N) rr r r r1rr=r@rrrErGr r rrwrwXs2 27Gr /  ,0\&42r rwcN t|S#t$rt|cYSwxYw)a Create and return an instance of a Filemap class - 'FilemapFiemap' or 'FilemapSeek', depending on what the system we run on supports. If the FIEMAP ioctl is supported, an instance of the 'FilemapFiemap' class is returned. Otherwise, if 'SEEK_HOLE' is supported an instance of the 'FilemapSeek' class is returned. If none of these are supported, the function generates an 'Error' type exception. )rwrrU)r.s rfilemapr-s,"U## "5!!"s $$) r rrMrrrr^loggingr getLoggerrr+ ExceptionrrobjectrrfrarSrUrcalcsizer|rr}rrrzrwrr r rrs" w" 9  I r56r5l  .sF,sFxv~. $%foo&;< !R2LR2j "r