3704fed5ea
This commit adds a new test case that demonstrates a bug in the split-index code that is triggered under certain circumstances when the FSMonitor is enabled, and its symptom manifests in the form of one of the following error messages: BUG: fsmonitor.c:20: fsmonitor_dirty has more entries than the index (2 > 1) BUG: unpack-trees.c:776: pos <n> doesn't point to the first entry of <dir>/ in index error: invalid path '' error: The following untracked working tree files would be overwritten by reset: initial.t Which of these error messages appears depends on timing-dependent conditions. Technically the root cause lies with a bug in the split-index code that has nothing to do with FSMonitor, but for the sake of this new test case it was the easiest way to trigger the bug. The bug is this: Under specific conditions, Git needs to skip writing the "link" extension (which is the index extension containing the information pertaining to the split-index). To do that, the `base_oid` attribute of the `split_index` structure in the in-memory index is zeroed out, and `do_write_index()` specifically checks for a "null" `base_oid` to understand that the "link" extension should not be written. However, this violates the consistency of the in-memory index structure, but that does not cause problems in most cases because the process exits without using the in-memory index structure anymore, anyway. But: _When_ the in-memory index is still used (which is the case e.g. in `git rebase`), subsequent writes of `the_index` are at risk of writing out a bogus index file, one that _should_ have a "link" extension but does not. In many cases, the `SPLIT_INDEX_ORDERED` flag _happens_ to be set for subsequent writes, forcing the shared index to be written, which re-initializes `base_oid` to a non-bogus state, and all is good. When it is _not_ set, however, all kinds of mayhem ensue, resulting in above-mentioned error messages, and often enough putting worktrees in a totally broken state where the only recourse is to manually delete the `index` and the `index.lock` files and then call `git reset` manually. Not something to ask users to do. The reason why it is comparatively easy to trigger the bug with FSMonitor is that there is _another_ bug in the FSMonitor code: `mark_fsmonitor_valid()` sets `cache_changed` to 1, i.e. treating that variable as a Boolean. But it is a bit field, and 1 happens to be the `SOMETHING_CHANGED` bit that forces the "link" extension to be skipped when writing the index, among other things. "Comparatively easy" is a relative term in this context, for sure. The essence of how the new test case triggers the bug is as following: 1. The `git rebase` invocation will first reset the worktree to a commit that contains only the `one.t` file, and then execute a rebase script that starts with the following commands (commit hashes skipped): label onto reset initial pick two label two reset two pick three [...] 2. Before executing the `label` command, a split index is written, as well as the shared index. 3. The `reset initial` command in the rebase script writes out a new split index but skips writing the shared index, as intended. 4. The `pick two` command updates the worktree and refreshes the index, marking the `two.t` entry as valid via the FSMonitor, which sets the `SOMETHING_CHANGED` bit in `cache_changed`, which in turn causes the `base_oid` attribute to be zeroed out and a full (non-split) index to be written (making sure _not_ to write the "link" extension). 5. Now, the `reset two` command will leave the worktree alone, but still write out a new split index, not writing the shared index (because `base_oid` is still zeroed out, and there is no index entry update requiring it to be written, either). 6. When it is turn to run `pick three`, the index is read, but it is too short: It only contains a single entry when there should be two, because the "link" extension is missing from the written-out index file. There are three bugs at play, actually, which will be fixed over the course of the next commits: - The `base_oid` attribute should not be zeroed out to indicate when the "link" extension should not be written, as it puts the in-memory index structure into an inconsistent state. - The FSMonitor should not overwrite bits in `cache_changed`. - The `unpack_trees()` function tries to reuse the `split_index` structure from the source index, if any, but does not propagate the `SPLIT_INDEX_ORDERED` flag. While a fix for the second bug would let this test case pass, there are other conditions where the `SOMETHING_CHANGED` bit is set. Therefore, the bug that most crucially needs to be fixed is the first one. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com> |
||
---|---|---|
.github | ||
block-sha1 | ||
builtin | ||
ci | ||
compat | ||
contrib | ||
Documentation | ||
ewah | ||
git-gui | ||
gitk-git | ||
gitweb | ||
mergetools | ||
negotiator | ||
perl | ||
po | ||
ppc | ||
refs | ||
reftable | ||
sha1collisiondetection@855827c583 | ||
sha1dc | ||
sha256 | ||
t | ||
templates | ||
trace2 | ||
xdiff | ||
.cirrus.yml | ||
.clang-format | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
.mailmap | ||
.tsan-suppressions | ||
abspath.c | ||
aclocal.m4 | ||
add-interactive.c | ||
add-interactive.h | ||
add-patch.c | ||
advice.c | ||
advice.h | ||
alias.c | ||
alias.h | ||
alloc.c | ||
alloc.h | ||
apply.c | ||
apply.h | ||
archive-tar.c | ||
archive-zip.c | ||
archive.c | ||
archive.h | ||
attr.c | ||
attr.h | ||
banned.h | ||
base85.c | ||
bisect.c | ||
bisect.h | ||
blame.c | ||
blame.h | ||
blob.c | ||
blob.h | ||
bloom.c | ||
bloom.h | ||
branch.c | ||
branch.h | ||
builtin.h | ||
bulk-checkin.c | ||
bulk-checkin.h | ||
bundle.c | ||
bundle.h | ||
cache-tree.c | ||
cache-tree.h | ||
cache.h | ||
cbtree.c | ||
cbtree.h | ||
chdir-notify.c | ||
chdir-notify.h | ||
check-builtins.sh | ||
checkout.c | ||
checkout.h | ||
chunk-format.c | ||
chunk-format.h | ||
CODE_OF_CONDUCT.md | ||
color.c | ||
color.h | ||
column.c | ||
column.h | ||
combine-diff.c | ||
command-list.txt | ||
commit-graph.c | ||
commit-graph.h | ||
commit-reach.c | ||
commit-reach.h | ||
commit-slab-decl.h | ||
commit-slab-impl.h | ||
commit-slab.h | ||
commit.c | ||
commit.h | ||
common-main.c | ||
config.c | ||
config.h | ||
config.mak.dev | ||
config.mak.in | ||
config.mak.uname | ||
configure.ac | ||
connect.c | ||
connect.h | ||
connected.c | ||
connected.h | ||
convert.c | ||
convert.h | ||
copy.c | ||
COPYING | ||
credential.c | ||
credential.h | ||
csum-file.c | ||
csum-file.h | ||
ctype.c | ||
daemon.c | ||
date.c | ||
date.h | ||
decorate.c | ||
decorate.h | ||
delta-islands.c | ||
delta-islands.h | ||
delta.h | ||
detect-compiler | ||
diff-delta.c | ||
diff-lib.c | ||
diff-merges.c | ||
diff-merges.h | ||
diff-no-index.c | ||
diff.c | ||
diff.h | ||
diffcore-break.c | ||
diffcore-delta.c | ||
diffcore-order.c | ||
diffcore-pickaxe.c | ||
diffcore-rename.c | ||
diffcore-rotate.c | ||
diffcore.h | ||
dir-iterator.c | ||
dir-iterator.h | ||
dir.c | ||
dir.h | ||
editor.c | ||
entry.c | ||
entry.h | ||
environment.c | ||
environment.h | ||
exec-cmd.c | ||
exec-cmd.h | ||
fetch-negotiator.c | ||
fetch-negotiator.h | ||
fetch-pack.c | ||
fetch-pack.h | ||
fmt-merge-msg.c | ||
fmt-merge-msg.h | ||
fsck.c | ||
fsck.h | ||
fsmonitor--daemon.h | ||
fsmonitor-ipc.c | ||
fsmonitor-ipc.h | ||
fsmonitor-settings.c | ||
fsmonitor-settings.h | ||
fsmonitor.c | ||
fsmonitor.h | ||
fuzz-commit-graph.c | ||
fuzz-pack-headers.c | ||
fuzz-pack-idx.c | ||
generate-cmdlist.sh | ||
generate-configlist.sh | ||
generate-hooklist.sh | ||
gettext.c | ||
gettext.h | ||
git-add--interactive.perl | ||
git-archimport.perl | ||
git-bisect.sh | ||
git-compat-util.h | ||
git-curl-compat.h | ||
git-cvsexportcommit.perl | ||
git-cvsimport.perl | ||
git-cvsserver.perl | ||
git-difftool--helper.sh | ||
git-filter-branch.sh | ||
git-instaweb.sh | ||
git-merge-octopus.sh | ||
git-merge-one-file.sh | ||
git-merge-resolve.sh | ||
git-mergetool--lib.sh | ||
git-mergetool.sh | ||
git-p4.py | ||
git-quiltimport.sh | ||
git-request-pull.sh | ||
git-send-email.perl | ||
git-sh-i18n.sh | ||
git-sh-setup.sh | ||
git-submodule.sh | ||
git-svn.perl | ||
GIT-VERSION-GEN | ||
git-web--browse.sh | ||
git.c | ||
git.rc | ||
gpg-interface.c | ||
gpg-interface.h | ||
graph.c | ||
graph.h | ||
grep.c | ||
grep.h | ||
hash-lookup.c | ||
hash-lookup.h | ||
hash.h | ||
hashmap.c | ||
hashmap.h | ||
help.c | ||
help.h | ||
hex.c | ||
hook.c | ||
hook.h | ||
http-backend.c | ||
http-fetch.c | ||
http-push.c | ||
http-walker.c | ||
http.c | ||
http.h | ||
ident.c | ||
imap-send.c | ||
INSTALL | ||
iterator.h | ||
json-writer.c | ||
json-writer.h | ||
khash.h | ||
kwset.c | ||
kwset.h | ||
levenshtein.c | ||
levenshtein.h | ||
LGPL-2.1 | ||
line-log.c | ||
line-log.h | ||
line-range.c | ||
line-range.h | ||
linear-assignment.c | ||
linear-assignment.h | ||
list-objects-filter-options.c | ||
list-objects-filter-options.h | ||
list-objects-filter.c | ||
list-objects-filter.h | ||
list-objects.c | ||
list-objects.h | ||
list.h | ||
ll-merge.c | ||
ll-merge.h | ||
lockfile.c | ||
lockfile.h | ||
log-tree.c | ||
log-tree.h | ||
ls-refs.c | ||
ls-refs.h | ||
mailinfo.c | ||
mailinfo.h | ||
mailmap.c | ||
mailmap.h | ||
Makefile | ||
match-trees.c | ||
mem-pool.c | ||
mem-pool.h | ||
merge-blobs.c | ||
merge-blobs.h | ||
merge-ort-wrappers.c | ||
merge-ort-wrappers.h | ||
merge-ort.c | ||
merge-ort.h | ||
merge-recursive.c | ||
merge-recursive.h | ||
merge.c | ||
mergesort.c | ||
mergesort.h | ||
midx.c | ||
midx.h | ||
name-hash.c | ||
notes-cache.c | ||
notes-cache.h | ||
notes-merge.c | ||
notes-merge.h | ||
notes-utils.c | ||
notes-utils.h | ||
notes.c | ||
notes.h | ||
object-file.c | ||
object-name.c | ||
object-store.h | ||
object.c | ||
object.h | ||
oid-array.c | ||
oid-array.h | ||
oidmap.c | ||
oidmap.h | ||
oidset.c | ||
oidset.h | ||
oidtree.c | ||
oidtree.h | ||
pack-bitmap-write.c | ||
pack-bitmap.c | ||
pack-bitmap.h | ||
pack-check.c | ||
pack-mtimes.c | ||
pack-mtimes.h | ||
pack-objects.c | ||
pack-objects.h | ||
pack-revindex.c | ||
pack-revindex.h | ||
pack-write.c | ||
pack.h | ||
packfile.c | ||
packfile.h | ||
pager.c | ||
parallel-checkout.c | ||
parallel-checkout.h | ||
parse-options-cb.c | ||
parse-options.c | ||
parse-options.h | ||
patch-delta.c | ||
patch-ids.c | ||
patch-ids.h | ||
path.c | ||
path.h | ||
pathspec.c | ||
pathspec.h | ||
pkt-line.c | ||
pkt-line.h | ||
preload-index.c | ||
pretty.c | ||
pretty.h | ||
prio-queue.c | ||
prio-queue.h | ||
progress.c | ||
progress.h | ||
promisor-remote.c | ||
promisor-remote.h | ||
prompt.c | ||
prompt.h | ||
protocol-caps.c | ||
protocol-caps.h | ||
protocol.c | ||
protocol.h | ||
prune-packed.c | ||
prune-packed.h | ||
quote.c | ||
quote.h | ||
range-diff.c | ||
range-diff.h | ||
reachable.c | ||
reachable.h | ||
read-cache.c | ||
README.md | ||
rebase-interactive.c | ||
rebase-interactive.h | ||
rebase.c | ||
rebase.h | ||
ref-filter.c | ||
ref-filter.h | ||
reflog-walk.c | ||
reflog-walk.h | ||
reflog.c | ||
reflog.h | ||
refs.c | ||
refs.h | ||
refspec.c | ||
refspec.h | ||
RelNotes | ||
remote-curl.c | ||
remote.c | ||
remote.h | ||
replace-object.c | ||
replace-object.h | ||
repo-settings.c | ||
repository.c | ||
repository.h | ||
rerere.c | ||
rerere.h | ||
reset.c | ||
reset.h | ||
resolve-undo.c | ||
resolve-undo.h | ||
revision.c | ||
revision.h | ||
run-command.c | ||
run-command.h | ||
SECURITY.md | ||
send-pack.c | ||
send-pack.h | ||
sequencer.c | ||
sequencer.h | ||
serve.c | ||
serve.h | ||
server-info.c | ||
setup.c | ||
sh-i18n--envsubst.c | ||
sha1dc_git.c | ||
sha1dc_git.h | ||
shallow.c | ||
shallow.h | ||
shared.mak | ||
shell.c | ||
shortlog.h | ||
sideband.c | ||
sideband.h | ||
sigchain.c | ||
sigchain.h | ||
simple-ipc.h | ||
sparse-index.c | ||
sparse-index.h | ||
split-index.c | ||
split-index.h | ||
stable-qsort.c | ||
strbuf.c | ||
strbuf.h | ||
streaming.c | ||
streaming.h | ||
string-list.c | ||
string-list.h | ||
strmap.c | ||
strmap.h | ||
strvec.c | ||
strvec.h | ||
sub-process.c | ||
sub-process.h | ||
submodule-config.c | ||
submodule-config.h | ||
submodule.c | ||
submodule.h | ||
symlinks.c | ||
tag.c | ||
tag.h | ||
tar.h | ||
tempfile.c | ||
tempfile.h | ||
thread-utils.c | ||
thread-utils.h | ||
tmp-objdir.c | ||
tmp-objdir.h | ||
trace2.c | ||
trace2.h | ||
trace.c | ||
trace.h | ||
trailer.c | ||
trailer.h | ||
transport-helper.c | ||
transport-internal.h | ||
transport.c | ||
transport.h | ||
tree-diff.c | ||
tree-walk.c | ||
tree-walk.h | ||
tree.c | ||
tree.h | ||
unicode-width.h | ||
unimplemented.sh | ||
unix-socket.c | ||
unix-socket.h | ||
unix-stream-server.c | ||
unix-stream-server.h | ||
unpack-trees.c | ||
unpack-trees.h | ||
upload-pack.c | ||
upload-pack.h | ||
url.c | ||
url.h | ||
urlmatch.c | ||
urlmatch.h | ||
usage.c | ||
userdiff.c | ||
userdiff.h | ||
utf8.c | ||
utf8.h | ||
varint.c | ||
varint.h | ||
version.c | ||
version.h | ||
versioncmp.c | ||
walker.c | ||
walker.h | ||
wildmatch.c | ||
wildmatch.h | ||
worktree.c | ||
worktree.h | ||
wrap-for-bin.sh | ||
wrapper.c | ||
write-or-die.c | ||
ws.c | ||
wt-status.c | ||
wt-status.h | ||
xdiff-interface.c | ||
xdiff-interface.h | ||
zlib.c |
Git - fast, scalable, distributed revision control system
Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals.
Git is an Open Source project covered by the GNU General Public License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net.
Please read the file INSTALL for installation instructions.
Many Git online resources are accessible from https://git-scm.com/ including full documentation and Git related tools.
See Documentation/gittutorial.txt to get started, then see
Documentation/giteveryday.txt for a useful minimum set of commands, and
Documentation/git-<commandname>.txt
for documentation of each command.
If git has been correctly installed, then the tutorial can also be
read with man gittutorial
or git help tutorial
, and the
documentation of each command with man git-<commandname>
or git help <commandname>
.
CVS users may also want to read Documentation/gitcvs-migration.txt
(man gitcvs-migration
or git help cvs-migration
if git is
installed).
The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission and Documentation/CodingGuidelines).
Those wishing to help with error message, usage and informational message
string translations (localization l10) should see po/README.md
(a po
file is a Portable Object file that holds the translations).
To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org (not the Git list). The mailing list archives are available at https://lore.kernel.org/git/, http://marc.info/?l=git and other archival sites.
Issues which are security relevant should be disclosed privately to the Git Security mailing list git-security@googlegroups.com.
The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks.
The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood):
- random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant.
- stupid. contemptible and despicable. simple. Take your pick from the dictionary of slang.
- "global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room.
- "goddamn idiotic truckload of sh*t": when it breaks