d3775de074
Compiling with -O2 can interact badly with LSan's leak-checker, causing false positives. Imagine a simplified example like: char *str = allocate_some_string(); if (some_func(str) < 0) die("bad str"); free(str); The compiler may eliminate "str" as a stack variable, and just leave it in a register. The register is preserved through most of the function, including across the call to some_func(), since we'd eventually need to free it. But because die() is marked with NORETURN, the compiler knows that it doesn't need to save registers, and just clobbers it. When die() eventually exits, the leak-checker runs. It looks in registers and on the stack for any reference to the memory allocated by str (which would indicate that it's not leaked), but can't find one. So it reports it as a leak. Neither system is wrong, really. The C standard (mostly section 5.1.2.3) defines an abstract machine, and compilers are allowed to modify the program as long as the observable behavior of that abstract machine is unchanged. Looking at random memory values on the stack is undefined behavior, and not something that the optimizer needs to support. But there really isn't any other way for a leak checker to work; it inherently has to do undefined things like scouring memory for pointers. So the two things are inherently at odds with each other. We can't fix it by changing the code, because from the perspective of the program running in an abstract machine, there is no leak. This has caused real false positives in the past, like: - https://lore.kernel.org/git/patch-v3-5.6-9a44204c4c9-20211022T175227Z-avarab@gmail.com/ - https://lore.kernel.org/git/Yy4eo6500C0ijhk+@coredump.intra.peff.net/ - https://lore.kernel.org/git/Y07yeEQu+C7AH7oN@nand.local/ This patch makes those go away by forcing -O0 when compiling with LSan. There are a few ways we could do this: - we could just teach the linux-leaks CI job to set -O0. That's the smallest change, and means we wouldn't get spurious CI failures. But it doesn't help people looking for leaks manually or in a specific test (and because the problem depends on the vagaries of the optimizer, investigating these can waste a lot of time in head-scratching as the problem comes and goes) - we default to -O2 in CFLAGS; we could pull this out to a separate variable ("-O$(O)" or something) and modify "O" when LSan is in use. This is the most flexible, in that you could still build with "make O=2 SANITIZE=leak" if you really wanted to (say, for experimenting). But it would also fail to kick in if the user defines their own CFLAGS variable, which again leads to head-scratching. - we can just stick -O0 into BASIC_CFLAGS when enabling LSan. Since this comes after the user-provided CFLAGS, it will override any previous -O setting found there. This is more foolproof, albeit less flexible. If you want to experiment with an optimized leak-checking build, you'll have to put "-O2 -fsanitize=leak" into CFLAGS manually, rather than using our SANITIZE=leak Makefile magic. Since the final one is the least likely to break in normal use, this patch uses that approach. The resulting build is a little slower, of course, but since LSan is already about 2x slower than a regular build, another 10% slowdown isn't that big a deal. Signed-off-by: Jeff King <peff@peff.net> 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 | ||
oss-fuzz | ||
perl | ||
po | ||
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-uri.c | ||
bundle-uri.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 | ||
diagnose.c | ||
diagnose.h | ||
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-path-utils.h | ||
fsmonitor-settings.c | ||
fsmonitor-settings.h | ||
fsmonitor.c | ||
fsmonitor.h | ||
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.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 | ||
scalar.c | ||
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