mirror/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-19 09:28:35 +02:00
Code
Git Source Code Mirror. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
68,298 Commits 6 Branches 956 Tags 349 MiB
C 50.3%
Shell 38.6%
Perl 5.2%
Tcl 3.3%
Python 0.8%
Other 1.6%
d3775de074
Go to file
Jeff King d3775de074 Makefile: force -O0 when compiling with SANITIZE=leak 
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>
2022-10-19 08:32:39 -07:00
.github
block-sha1
builtin Git 2.38.1 2022-10-17 15:46:09 -07:00
ci
compat Merge branch 'ed/fsmonitor-on-networked-macos' 2022-10-17 14:56:31 -07:00
contrib Merge branch 'ed/fsmonitor-on-networked-macos' 2022-10-17 14:56:31 -07:00
Documentation Git 2.38.1 2022-10-17 15:46:09 -07:00
ewah
git-gui
gitk-git
gitweb
mergetools
negotiator
oss-fuzz Merge branch 'ac/fuzzers' 2022-10-07 17:19:59 -07:00
perl
po l10n: zh_TW.po: Git 2.38.0, round 3 2022-10-01 19:10:41 +08:00
refs refs: unify parse_worktree_ref() and ref_type() 2022-09-19 11:11:11 -07:00
reftable reftable: use a pointer for pq_entry param 2022-09-15 11:32:37 -07:00
sha1collisiondetection@855827c583
sha1dc
sha256
t Git 2.38.1 2022-10-17 15:46:09 -07:00
templates
trace2
xdiff
.cirrus.yml
.clang-format
.editorconfig
.gitattributes
.gitignore Merge branch 'ac/fuzzers' 2022-10-07 17:19:59 -07:00
.gitmodules
.mailmap
.tsan-suppressions
abspath.c
aclocal.m4
add-interactive.c
add-interactive.h
add-patch.c Merge branch 'rs/add-p-worktree-mode-prompt-fix' 2022-09-15 16:09:46 -07:00
advice.c
advice.h
alias.c alias.c: reject too-long cmdline strings in split_cmdline() 2022-10-01 00:23:38 -04:00
alias.h
alloc.c
alloc.h
apply.c
apply.h
archive-tar.c
archive-zip.c
archive.c
archive.h
attr.c attr: drop DEBUG_ATTR code 2022-10-06 09:59:17 -07:00
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 version: fix builtin linking & documentation 2022-09-19 17:28:25 -07:00
commit-graph.c Merge branch 'ml/commit-graph-expire-dir-leak-fix' 2022-09-21 14:23:14 -07:00
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.c: refactor to safely use 'd_type' 2022-09-19 10:25:01 -07:00
diagnose.h
diff-delta.c
diff-lib.c
diff-merges.c diff-merges: cleanup set_diff_merges() 2022-09-16 09:21:43 -07:00
diff-merges.h
diff-no-index.c
diff.c Merge branch 'en/remerge-diff-fixes' 2022-09-15 16:09:46 -07:00
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 Merge branch 'rs/use-fspathncmp' 2022-10-17 14:56:35 -07:00
dir.h
editor.c
entry.c
entry.h
environment.c Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
environment.h
exec-cmd.c
exec-cmd.h
fetch-negotiator.c
fetch-negotiator.h
fetch-pack.c Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
fetch-pack.h
fmt-merge-msg.c
fmt-merge-msg.h
fsck.c
fsck.h
fsmonitor--daemon.h fsmonitor: deal with synthetic firmlinks on macOS 2022-10-05 11:05:23 -07:00
fsmonitor-ipc.c fsmonitor: relocate socket file if .git directory is remote 2022-10-05 11:05:22 -07:00
fsmonitor-ipc.h fsmonitor: relocate socket file if .git directory is remote 2022-10-05 11:05:22 -07:00
fsmonitor-path-utils.h fsmonitor: deal with synthetic firmlinks on macOS 2022-10-05 11:05:23 -07:00
fsmonitor-settings.c fsmonitor: check for compatability before communicating with fsmonitor 2022-10-05 11:05:23 -07:00
fsmonitor-settings.h fsmonitor: check for compatability before communicating with fsmonitor 2022-10-05 11:05:23 -07:00
fsmonitor.c fsmonitor: fix leak of warning message 2022-10-10 22:16:56 -07:00
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 Merge branch 'ab/unused-annotation' 2022-10-17 14:56:34 -07:00
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 Start 2.39 cycle 2022-10-07 17:19:59 -07:00
git-web--browse.sh
git.c
git.rc
gpg-interface.c Merge branch 'pw/ssh-sign-report-errors' 2022-10-11 10:36:11 -07:00
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: fix doubled words in explanation for developer interfaces 2022-09-16 09:20:11 -07:00
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: initialize sub-filter structs 2022-09-22 12:43:04 -07:00
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 Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
log-tree.h
ls-refs.c
ls-refs.h
mailinfo.c mailinfo -b: fix an out of bounds access 2022-10-03 09:05:07 -07:00
mailinfo.h
mailmap.c
mailmap.h
Makefile Makefile: force -O0 when compiling with SANITIZE=leak 2022-10-19 08:32:39 -07:00
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: return early when failing to write a blob 2022-09-28 08:49:35 -07:00
merge-ort.h
merge-recursive.c
merge-recursive.h
merge.c
mergesort.h
midx.c midx.c: avoid cruft packs with non-zero repack --batch-size 2022-09-21 10:21:47 -07:00
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 Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
notes.h
object-file.c Merge branch 'jt/promisor-remote-fetch-tweak' 2022-10-17 14:56:35 -07:00
object-name.c
object-store.h
object.c Merge branch 'jk/fsck-on-diet' 2022-10-10 10:08:39 -07:00
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 Merge branch 'ds/bitmap-lookup-remove-tracing' 2022-09-26 21:46:51 -07:00
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 Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
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 Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
pretty.h
prio-queue.c
prio-queue.h
progress.c
progress.h
promisor-remote.c promisor-remote: die upon failing fetch 2022-10-05 11:06:53 -07:00
promisor-remote.h promisor-remote: remove a return value 2022-10-05 11:06:52 -07:00
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 Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
range-diff.h
reachable.c
reachable.h
read-cache.c read-cache: avoid misaligned reads in index v4 2022-09-28 10:32:18 -07:00
README.md
rebase-interactive.c
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c Merge branch 'rj/ref-filter-get-head-description-leakfix' 2022-10-10 10:08:42 -07:00
ref-filter.h
reflog-walk.c
reflog-walk.h
reflog.c refs: unify parse_worktree_ref() and ref_type() 2022-09-19 11:11:11 -07:00
reflog.h
refs.c refs: unify parse_worktree_ref() and ref_type() 2022-09-19 11:11:11 -07:00
refs.h refs: unify parse_worktree_ref() and ref_type() 2022-09-19 11:11:11 -07:00
refspec.c
refspec.h
RelNotes Start 2.39 cycle 2022-10-07 17:19:59 -07:00
remote-curl.c
remote.c
remote.h
replace-object.c
replace-object.h
repo-settings.c Merge branch 'jk/plug-list-object-filter-leaks' 2022-09-14 12:56:40 -07:00
repository.c
repository.h
rerere.c
rerere.h
reset.c
reset.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'jk/list-objects-filter-cleanup' 2022-09-19 14:35:24 -07:00
revision.h
run-command.c
run-command.h
scalar.c scalar: make 'unregister' idempotent 2022-09-27 09:32:26 -07:00
SECURITY.md
send-pack.c
send-pack.h
sequencer.c Merge branch 'jk/sequencer-missing-author-name-check' 2022-10-11 10:36:12 -07:00
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 Sync with 2.32.4 2022-10-06 17:42:02 -04:00
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 string-list: document iterator behavior on NULL input 2022-09-27 09:32:26 -07:00
strmap.c
strmap.h
strvec.c
strvec.h
sub-process.c
sub-process.h
submodule-config.c
submodule-config.h
submodule.c Merge branch 'ab/unused-annotation' 2022-09-14 12:56:39 -07:00
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: skip clean up when handling a signal 2022-09-30 21:26:58 -07:00
tmp-objdir.h
trace2.c
trace2.h
trace.c
trace.h
trailer.c
trailer.h
transport-helper.c
transport-internal.h
transport.c Sync with 2.37.4 2022-10-06 20:00:04 -04:00
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 Merge branch 'jk/list-objects-filter-cleanup' 2022-09-19 14:35:24 -07:00
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 refs: unify parse_worktree_ref() and ref_type() 2022-09-19 11:11:11 -07:00
worktree.h refs: unify parse_worktree_ref() and ref_type() 2022-09-19 11:11:11 -07:00
wrap-for-bin.sh
wrapper.c
write-or-die.c environ: GIT_FLUSH should be made a usual Boolean 2022-09-15 11:34:51 -07:00
ws.c
wt-status.c
wt-status.h
xdiff-interface.c
xdiff-interface.h
zlib.c

README.md

Build status

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