( )⚙ D10793 revlog: add a function to build index entry tuple

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10793

revlog: add a function to build index entry tuple
ClosedPublic

Authored by marmoute on May 30 2021, 1:29 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHGa669404f0f4a: revlog: add a function to build index entry tuple
Summary

Keeping index entry as tuple make sense for performance reason, however it does
not means we need to manually build that tuple for all piece of python code that
are not performance critical.

So we add a nice function responsible to build the tuple using argument using
explicit keyword argument.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

marmoute created this revision.May 30 2021, 1:29 PM
baymax updated this revision to Diff 28306.May 31 2021, 6:51 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

Alphare accepted this revision as: Alphare.May 31 2021, 10:42 AM
baymax updated this revision to Diff 28321.May 31 2021, 4:21 PM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 28403.Jun 1 2021, 11:17 PM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 28418.Jun 2 2021, 7:43 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 28452.Jun 4 2021, 11:05 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 28474.Jun 7 2021, 5:16 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

marmoute added a commit: rHGa669404f0f4a: revlog: add a function to build index entry tuple.Jun 7 2021, 5:25 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGa669404f0f4a: revlog: add a function to build index entry tuple (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 28496

mercurial/revlogutils/__init__.py

# mercurial.revlogutils -- basic utilities for revlog # mercurial.revlogutils -- basic utilities for revlog
# #
# Copyright 2019 Pierre-Yves David <pierre-yves.david@octobus.net> # Copyright 2019 Pierre-Yves David <pierre-yves.david@octobus.net>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
from ..interfaces import repository from ..interfaces import repository
# See mercurial.revlogutils.constants for doc
COMP_MODE_INLINE = 2
def offset_type(offset, type): def offset_type(offset, type):
if (type & ~repository.REVISION_FLAGS_KNOWN) != 0: if (type & ~repository.REVISION_FLAGS_KNOWN) != 0:
raise ValueError(b'unknown revlog index flags: %d' % type) raise ValueError(b'unknown revlog index flags: %d' % type)
return int(int(offset) << 16 | type) return int(int(offset) << 16 | type)
def entry(
data_offset,
data_compressed_length,
data_delta_base,
link_rev,
parent_rev_1,
parent_rev_2,
node_id,
flags=0,
data_uncompressed_length=-1,
data_compression_mode=COMP_MODE_INLINE,
sidedata_offset=0,
sidedata_compressed_length=0,
sidedata_compression_mode=COMP_MODE_INLINE,
):
"""Build one entry from symbolic name
This is useful to abstract the actual detail of how we build the entry
tuple for caller who don't care about it.
This should always be called using keyword arguments. Some arguments have
default value, this match the value used by index version that does not store such data.
"""
return (
offset_type(data_offset, flags),
data_compressed_length,
data_uncompressed_length,
data_delta_base,
link_rev,
parent_rev_1,
parent_rev_2,
node_id,
sidedata_offset,
sidedata_compressed_length,
data_compression_mode,
sidedata_compression_mode,
)

mercurial/revlogutils/constants.py

# revlogdeltas.py - constant used for revlog logic. # revlogdeltas.py - constant used for revlog logic.
# #
# Copyright 2005-2007 Olivia Mackall <olivia@selenic.com> # Copyright 2005-2007 Olivia Mackall <olivia@selenic.com>
# Copyright 2018 Octobus <contact@octobus.net> # Copyright 2018 Octobus <contact@octobus.net>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
"""Helper class to compute deltas stored inside revlogs""" """Helper class to compute deltas stored inside revlogs"""
from __future__ import absolute_import from __future__ import absolute_import
import struct import struct
from ..interfaces import repository from ..interfaces import repository
from .. import revlogutils
### Internal utily constants ### Internal utily constants
KIND_CHANGELOG = 1001 # over 256 to not be comparable with a bytes KIND_CHANGELOG = 1001 # over 256 to not be comparable with a bytes
KIND_MANIFESTLOG = 1002 KIND_MANIFESTLOG = 1002
KIND_FILELOG = 1003 KIND_FILELOG = 1003
KIND_OTHER = 1004 KIND_OTHER = 1004
# #
# XXX: The value of allow mixed type of compression in the revlog is unclear # XXX: The value of allow mixed type of compression in the revlog is unclear
# and we should consider making PLAIN/DEFAULT the only available mode for # and we should consider making PLAIN/DEFAULT the only available mode for
# revlog v2, disallowing INLINE mode. # revlog v2, disallowing INLINE mode.
COMP_MODE_DEFAULT = 1 COMP_MODE_DEFAULT = 1
# Chunk use a compression mode stored "inline" at the start of the chunk # Chunk use a compression mode stored "inline" at the start of the chunk
# itself. This is the mode always used for revlog version "0" and "1" # itself. This is the mode always used for revlog version "0" and "1"
COMP_MODE_INLINE = 2 COMP_MODE_INLINE = revlogutils.COMP_MODE_INLINE
SUPPORTED_FLAGS = { SUPPORTED_FLAGS = {
REVLOGV0: REVLOGV0_FLAGS, REVLOGV0: REVLOGV0_FLAGS,
REVLOGV1: REVLOGV1_FLAGS, REVLOGV1: REVLOGV1_FLAGS,
REVLOGV2: REVLOGV2_FLAGS, REVLOGV2: REVLOGV2_FLAGS,
CHANGELOGV2: CHANGELOGV2_FLAGS, CHANGELOGV2: CHANGELOGV2_FLAGS,
} }