upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-05-28 04:03:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #8978 from ThomasWaldmann/chunkerparams-validation-1.4

Browse source 
fix ChunkerParams validation
This commit is contained in:
TW 2025-08-05 16:14:15 +02:00 committed by GitHub
commit 28bcefded8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/borg/helpers/parseformat.py
View file

@ -106,16 +106,10 @@ def interval(s):
def ChunkerParams(s):
def reject_or_warn(msg, reject):
if reject:
raise argparse.ArgumentTypeError(msg)
else:
logger.warning(msg)
params = s.strip().split(',')
count = len(params)
if count == 0:
reject_or_warn('no chunker params given', True)
raise argparse.ArgumentTypeError('no chunker params given')
algo = params[0].lower()
if algo == CH_FIXED and 2 <= count <= 3: # fixed, block_size[, header_size]
block_size = int(params[1])
@ -126,9 +120,9 @@ def ChunkerParams(s):
# or in-memory chunk management.
# choose the block (chunk) size wisely: if you have a lot of data and you cut
# it into very small chunks, you are asking for trouble!
reject_or_warn('block_size must not be less than 64 Bytes', False)
raise argparse.ArgumentTypeError('block_size must not be less than 64 Bytes')
if block_size > MAX_DATA_SIZE or header_size > MAX_DATA_SIZE:
reject_or_warn('block_size and header_size must not exceed MAX_DATA_SIZE [%d]' % MAX_DATA_SIZE, True)
raise argparse.ArgumentTypeError('block_size and header_size must not exceed MAX_DATA_SIZE [%d]' % MAX_DATA_SIZE)
return algo, block_size, header_size
if algo == 'default' and count == 1: # default
return CHUNKER_PARAMS
@ -136,14 +130,14 @@ def ChunkerParams(s):
if algo == CH_BUZHASH and count == 5 or count == 4: # [buzhash, ]chunk_min, chunk_max, chunk_mask, window_size
chunk_min, chunk_max, chunk_mask, window_size = (int(p) for p in params[count - 4:])
if not (chunk_min <= chunk_mask <= chunk_max):
reject_or_warn('required: chunk_min <= chunk_mask <= chunk_max', False)
raise argparse.ArgumentTypeError('required: chunk_min <= chunk_mask <= chunk_max')
if chunk_min < 6:
# see comment in 'fixed' algo check
reject_or_warn('min. chunk size exponent must not be less than 6 (2^6 = 64B min. chunk size)', False)
raise argparse.ArgumentTypeError('min. chunk size exponent must not be less than 6 (2^6 = 64B min. chunk size)')
if chunk_max > 23:
reject_or_warn('max. chunk size exponent must not be more than 23 (2^23 = 8MiB max. chunk size)', True)
raise argparse.ArgumentTypeError('max. chunk size exponent must not be more than 23 (2^23 = 8MiB max. chunk size)')
if window_size % 2 == 0:
reject_or_warn("window_size must be an uneven (odd) number", False)
raise argparse.ArgumentTypeError("window_size must be an uneven (odd) number")
return CH_BUZHASH, chunk_min, chunk_max, chunk_mask, window_size
raise argparse.ArgumentTypeError('invalid chunker params')

6
src/borg/testsuite/archiver.py
View file

@ -3229,7 +3229,7 @@ class ArchiverTestCase(ArchiverTestCaseBase):
fd.write(b'a' * 280)
fd.write(b'b' * 280)
self.cmd('init', '--encryption=repokey', self.repository_location)
self.cmd('create', '--chunker-params', '7,9,8,128', self.repository_location + '::test1', 'input')
self.cmd('create', '--chunker-params', '7,9,8,127', self.repository_location + '::test1', 'input')
self.cmd('create', self.repository_location + '::test2', 'input', '--files-cache=disabled')
list = self.cmd('list', self.repository_location + '::test1', 'input/large_file',
'--format', '{num_chunks} {unique_chunks}')
@ -3247,7 +3247,7 @@ class ArchiverTestCase(ArchiverTestCaseBase):
with open(os.path.join(self.input_path, 'file'), 'wb') as fd:
fd.write(b'a' * 8192)
self.cmd('init', '--encryption=repokey', self.repository_location)
self.cmd('create', '--chunker-params', '7,9,8,128', self.repository_location + '::test', 'input')
self.cmd('create', '--chunker-params', '7,9,8,127', self.repository_location + '::test', 'input')
output = self.cmd('list', self.repository_location + '::test', 'input/file',
'--format', '{num_chunks}')
num_chunks = int(output)
@ -3263,7 +3263,7 @@ class ArchiverTestCase(ArchiverTestCaseBase):
fd.write(b'a' * 8192)
self.cmd('init', '--encryption=repokey', self.repository_location)
# first create an archive with non-default chunker params:
self.cmd('create', '--chunker-params', '7,9,8,128', self.repository_location + '::test', 'input')
self.cmd('create', '--chunker-params', '7,9,8,127', self.repository_location + '::test', 'input')
output = self.cmd('list', self.repository_location + '::test', 'input/file',
'--format', '{num_chunks}')
num_chunks = int(output)