revlog: skeleton support for version 2 revlogs There are a number of improvements we want to make to revlogs that will require a new version - version 2. It is unclear what the full set of improvements will be or when we'll be done with them. What I do know is that the process will likely take longer than a single release, will require input from various stakeholders to evaluate changes, and will have many contentious debates and bikeshedding. It is unrealistic to develop revlog version 2 up front: there are just too many uncertainties that we won't know until things are implemented and experiments are run. Some changes will also be invasive and prone to bit rot, so sitting on dozens of patches is not practical. This commit introduces skeleton support for version 2 revlogs in a way that is flexible and not bound by backwards compatibility concerns. An experimental repo requirement for denoting revlog v2 has been added. The requirement string has a sub-version component to it. This will allow us to declare multiple requirements in the course of developing revlog v2. Whenever we change the in-development revlog v2 format, we can tweak the string, creating a new requirement and locking out old clients. This will allow us to make as many backwards incompatible changes and experiments to revlog v2 as we want. In other words, we can land code and make meaningful progress towards revlog v2 while still maintaining extreme format flexibility up until the point we freeze the format and remove the experimental labels. To enable the new repo requirement, you must supply an experimental and undocumented config option. But not just any boolean flag will do: you need to explicitly use a value that no sane person should ever type. This is an additional guard against enabling revlog v2 on an installation it shouldn't be enabled on. The specific scenario I'm trying to prevent is say a user with a 4.4 client with a frozen format enabling the option but then downgrading to 4.3 and accidentally creating repos with an outdated and unsupported repo format. Requiring a "challenge" string should prevent this. Because the format is not yet finalized and I don't want to take any chances, revlog v2's version is currently 0xDEAD. I figure squatting on a value we're likely never to use as an actual revlog version to mean "internal testing only" is acceptable. And "dead" is easily recognized as something meaningful. There is a bunch of cleanup that is needed before work on revlog v2 begins in earnest. I plan on doing that work once this patch is accepted and we're comfortable with the idea of starting down this path.

     1

A repo with unknown revlogv2 requirement string cannot be opened

     2

     3

  $ hg init invalidreq

     4

  $ cd invalidreq

     5

  $ echo exp-revlogv2.unknown >> .hg/requires

     6

  $ hg log

     7

  abort: repository requires features unknown to this Mercurial: exp-revlogv2.unknown!

     8

  (see https://mercurial-scm.org/wiki/MissingRequirement for more information)

     9

  [255]

    10

  $ cd ..

    11

    12

Can create and open repo with revlog v2 requirement

    13

    14

  $ cat >> $HGRCPATH << EOF

    15

  > [experimental]

    16

  > revlogv2 = enable-unstable-format-and-corrupt-my-data

    17

  > EOF

    18

    19

  $ hg init empty-repo

    20

  $ cd empty-repo

    21

  $ cat .hg/requires

    22

  dotencode

    23

  exp-revlogv2.0

    24

  fncache

    25

  store

    26

    27

  $ hg log

    28

    29

Unknown flags to revlog are rejected

    30

    31

  >>> with open('.hg/store/00changelog.i', 'wb') as fh:

    32

  ...     fh.write('\x00\x04\xde\xad')

    33

    34

  $ hg log

    35

  abort: unknown flags (0x04) in version 57005 revlog 00changelog.i!

    36

  [255]

    37

    38

  $ cd ..

    39

    40

Writing a simple revlog v2 works

    41

    42

  $ hg init simple

    43

  $ cd simple

    44

  $ touch foo

    45

  $ hg -q commit -A -m initial

    46

    47

  $ hg log

    48

  changeset:   0:96ee1d7354c4

    49

  tag:         tip

    50

  user:        test

    51

  date:        Thu Jan 01 00:00:00 1970 +0000

    52

  summary:     initial

    53

    54

Header written as expected (changelog always disables generaldelta)

    55

    56

  $ f --hexdump --bytes 4 .hg/store/00changelog.i

    57

  .hg/store/00changelog.i:

    58

  0000: 00 01 de ad                                     |....|

    59

    60

  $ f --hexdump --bytes 4 .hg/store/data/foo.i

    61

  .hg/store/data/foo.i:

    62

  0000: 00 03 de ad                                     |....|