pack-bitmap: remove trace2 region from hot path

The trace2 region around the call to lazy_bitmap_for_commit() in
bitmap_for_commit() was added in 28cd730680d (pack-bitmap: prepare to
read lookup table extension, 2022-08-14). While adding trace2 regions is
typically helpful for tracking performance, this method is called
possibly thousands of times as a commit walk explores commit history
looking for a matching bitmap. When trace2 output is enabled, this
region is emitted many times and performance is throttled by that
output.

For now, remove these regions entirely.

This is a critical path, and it would be valuable to measure that the
time spent in bitmap_for_commit() does not increase when using the
commit lookup table. The best way to do that would be to use a mechanism
that sums the time spent in a region and reports a single value at the
end of the process. This technique was introduced but not merged by [1]
so maybe this example presents some justification to revisit that
approach.

[1] https://lore.kernel.org/git/pull.1099.v2.git.1640720202.gitgitgadget@gmail.com/

To help with the 'git blame' output in this region, add a comment that
warns against adding a trace2 region. Delete a test from t5310 that used
that trace output to check that this lookup optimization was activated.
To create this kind of test again in the future, the stopwatch traces
mentioned earlier could be used as a signal that we activated this code
path.

Helpedy-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2 files changed
tree: b82b6401f81836a796464e49a11f6cd15aa806d5
  1. .github/
  2. block-sha1/
  3. builtin/
  4. ci/
  5. compat/
  6. contrib/
  7. Documentation/
  8. ewah/
  9. git-gui/
  10. gitk-git/
  11. gitweb/
  12. mergetools/
  13. negotiator/
  14. perl/
  15. po/
  16. ppc/
  17. refs/
  18. reftable/
  19. sha1dc/
  20. sha256/
  21. t/
  22. templates/
  23. trace2/
  24. xdiff/
  25. .cirrus.yml
  26. .clang-format
  27. .editorconfig
  28. .gitattributes
  29. .gitignore
  30. .gitmodules
  31. .mailmap
  32. .tsan-suppressions
  33. abspath.c
  34. aclocal.m4
  35. add-interactive.c
  36. add-interactive.h
  37. add-patch.c
  38. advice.c
  39. advice.h
  40. alias.c
  41. alias.h
  42. alloc.c
  43. alloc.h
  44. apply.c
  45. apply.h
  46. archive-tar.c
  47. archive-zip.c
  48. archive.c
  49. archive.h
  50. attr.c
  51. attr.h
  52. banned.h
  53. base85.c
  54. bisect.c
  55. bisect.h
  56. blame.c
  57. blame.h
  58. blob.c
  59. blob.h
  60. bloom.c
  61. bloom.h
  62. branch.c
  63. branch.h
  64. builtin.h
  65. bulk-checkin.c
  66. bulk-checkin.h
  67. bundle.c
  68. bundle.h
  69. cache-tree.c
  70. cache-tree.h
  71. cache.h
  72. cbtree.c
  73. cbtree.h
  74. chdir-notify.c
  75. chdir-notify.h
  76. check-builtins.sh
  77. checkout.c
  78. checkout.h
  79. chunk-format.c
  80. chunk-format.h
  81. CODE_OF_CONDUCT.md
  82. color.c
  83. color.h
  84. column.c
  85. column.h
  86. combine-diff.c
  87. command-list.txt
  88. commit-graph.c
  89. commit-graph.h
  90. commit-reach.c
  91. commit-reach.h
  92. commit-slab-decl.h
  93. commit-slab-impl.h
  94. commit-slab.h
  95. commit.c
  96. commit.h
  97. common-main.c
  98. config.c
  99. config.h
  100. config.mak.dev
  101. config.mak.in
  102. config.mak.uname
  103. configure.ac
  104. connect.c
  105. connect.h
  106. connected.c
  107. connected.h
  108. convert.c
  109. convert.h
  110. copy.c
  111. COPYING
  112. credential.c
  113. credential.h
  114. csum-file.c
  115. csum-file.h
  116. ctype.c
  117. daemon.c
  118. date.c
  119. date.h
  120. decorate.c
  121. decorate.h
  122. delta-islands.c
  123. delta-islands.h
  124. delta.h
  125. detect-compiler
  126. diff-delta.c
  127. diff-lib.c
  128. diff-merges.c
  129. diff-merges.h
  130. diff-no-index.c
  131. diff.c
  132. diff.h
  133. diffcore-break.c
  134. diffcore-delta.c
  135. diffcore-order.c
  136. diffcore-pickaxe.c
  137. diffcore-rename.c
  138. diffcore-rotate.c
  139. diffcore.h
  140. dir-iterator.c
  141. dir-iterator.h
  142. dir.c
  143. dir.h
  144. editor.c
  145. entry.c
  146. entry.h
  147. environment.c
  148. environment.h
  149. exec-cmd.c
  150. exec-cmd.h
  151. fetch-negotiator.c
  152. fetch-negotiator.h
  153. fetch-pack.c
  154. fetch-pack.h
  155. fmt-merge-msg.c
  156. fmt-merge-msg.h
  157. fsck.c
  158. fsck.h
  159. fsmonitor--daemon.h
  160. fsmonitor-ipc.c
  161. fsmonitor-ipc.h
  162. fsmonitor-settings.c
  163. fsmonitor-settings.h
  164. fsmonitor.c
  165. fsmonitor.h
  166. fuzz-commit-graph.c
  167. fuzz-pack-headers.c
  168. fuzz-pack-idx.c
  169. generate-cmdlist.sh
  170. generate-configlist.sh
  171. generate-hooklist.sh
  172. gettext.c
  173. gettext.h
  174. git-add--interactive.perl
  175. git-archimport.perl
  176. git-bisect.sh
  177. git-compat-util.h
  178. git-curl-compat.h
  179. git-cvsexportcommit.perl
  180. git-cvsimport.perl
  181. git-cvsserver.perl
  182. git-difftool--helper.sh
  183. git-filter-branch.sh
  184. git-instaweb.sh
  185. git-merge-octopus.sh
  186. git-merge-one-file.sh
  187. git-merge-resolve.sh
  188. git-mergetool--lib.sh
  189. git-mergetool.sh
  190. git-p4.py
  191. git-quiltimport.sh
  192. git-request-pull.sh
  193. git-send-email.perl
  194. git-sh-i18n.sh
  195. git-sh-setup.sh
  196. git-submodule.sh
  197. git-svn.perl
  198. GIT-VERSION-GEN
  199. git-web--browse.sh
  200. git.c
  201. git.rc
  202. gpg-interface.c
  203. gpg-interface.h
  204. graph.c
  205. graph.h
  206. grep.c
  207. grep.h
  208. hash-lookup.c
  209. hash-lookup.h
  210. hash.h
  211. hashmap.c
  212. hashmap.h
  213. help.c
  214. help.h
  215. hex.c
  216. hook.c
  217. hook.h
  218. http-backend.c
  219. http-fetch.c
  220. http-push.c
  221. http-walker.c
  222. http.c
  223. http.h
  224. ident.c
  225. imap-send.c
  226. INSTALL
  227. iterator.h
  228. json-writer.c
  229. json-writer.h
  230. khash.h
  231. kwset.c
  232. kwset.h
  233. levenshtein.c
  234. levenshtein.h
  235. LGPL-2.1
  236. line-log.c
  237. line-log.h
  238. line-range.c
  239. line-range.h
  240. linear-assignment.c
  241. linear-assignment.h
  242. list-objects-filter-options.c
  243. list-objects-filter-options.h
  244. list-objects-filter.c
  245. list-objects-filter.h
  246. list-objects.c
  247. list-objects.h
  248. list.h
  249. ll-merge.c
  250. ll-merge.h
  251. lockfile.c
  252. lockfile.h
  253. log-tree.c
  254. log-tree.h
  255. ls-refs.c
  256. ls-refs.h
  257. mailinfo.c
  258. mailinfo.h
  259. mailmap.c
  260. mailmap.h
  261. Makefile
  262. match-trees.c
  263. mem-pool.c
  264. mem-pool.h
  265. merge-blobs.c
  266. merge-blobs.h
  267. merge-ort-wrappers.c
  268. merge-ort-wrappers.h
  269. merge-ort.c
  270. merge-ort.h
  271. merge-recursive.c
  272. merge-recursive.h
  273. merge.c
  274. mergesort.h
  275. midx.c
  276. midx.h
  277. name-hash.c
  278. notes-cache.c
  279. notes-cache.h
  280. notes-merge.c
  281. notes-merge.h
  282. notes-utils.c
  283. notes-utils.h
  284. notes.c
  285. notes.h
  286. object-file.c
  287. object-name.c
  288. object-store.h
  289. object.c
  290. object.h
  291. oid-array.c
  292. oid-array.h
  293. oidmap.c
  294. oidmap.h
  295. oidset.c
  296. oidset.h
  297. oidtree.c
  298. oidtree.h
  299. pack-bitmap-write.c
  300. pack-bitmap.c
  301. pack-bitmap.h
  302. pack-check.c
  303. pack-mtimes.c
  304. pack-mtimes.h
  305. pack-objects.c
  306. pack-objects.h
  307. pack-revindex.c
  308. pack-revindex.h
  309. pack-write.c
  310. pack.h
  311. packfile.c
  312. packfile.h
  313. pager.c
  314. parallel-checkout.c
  315. parallel-checkout.h
  316. parse-options-cb.c
  317. parse-options.c
  318. parse-options.h
  319. patch-delta.c
  320. patch-ids.c
  321. patch-ids.h
  322. path.c
  323. path.h
  324. pathspec.c
  325. pathspec.h
  326. pkt-line.c
  327. pkt-line.h
  328. preload-index.c
  329. pretty.c
  330. pretty.h
  331. prio-queue.c
  332. prio-queue.h
  333. progress.c
  334. progress.h
  335. promisor-remote.c
  336. promisor-remote.h
  337. prompt.c
  338. prompt.h
  339. protocol-caps.c
  340. protocol-caps.h
  341. protocol.c
  342. protocol.h
  343. prune-packed.c
  344. prune-packed.h
  345. quote.c
  346. quote.h
  347. range-diff.c
  348. range-diff.h
  349. reachable.c
  350. reachable.h
  351. read-cache.c
  352. README.md
  353. rebase-interactive.c
  354. rebase-interactive.h
  355. rebase.c
  356. rebase.h
  357. ref-filter.c
  358. ref-filter.h
  359. reflog-walk.c
  360. reflog-walk.h
  361. reflog.c
  362. reflog.h
  363. refs.c
  364. refs.h
  365. refspec.c
  366. refspec.h
  367. remote-curl.c
  368. remote.c
  369. remote.h
  370. replace-object.c
  371. replace-object.h
  372. repo-settings.c
  373. repository.c
  374. repository.h
  375. rerere.c
  376. rerere.h
  377. reset.c
  378. reset.h
  379. resolve-undo.c
  380. resolve-undo.h
  381. revision.c
  382. revision.h
  383. run-command.c
  384. run-command.h
  385. SECURITY.md
  386. send-pack.c
  387. send-pack.h
  388. sequencer.c
  389. sequencer.h
  390. serve.c
  391. serve.h
  392. server-info.c
  393. setup.c
  394. sh-i18n--envsubst.c
  395. sha1dc_git.c
  396. sha1dc_git.h
  397. shallow.c
  398. shallow.h
  399. shared.mak
  400. shell.c
  401. shortlog.h
  402. sideband.c
  403. sideband.h
  404. sigchain.c
  405. sigchain.h
  406. simple-ipc.h
  407. sparse-index.c
  408. sparse-index.h
  409. split-index.c
  410. split-index.h
  411. stable-qsort.c
  412. strbuf.c
  413. strbuf.h
  414. streaming.c
  415. streaming.h
  416. string-list.c
  417. string-list.h
  418. strmap.c
  419. strmap.h
  420. strvec.c
  421. strvec.h
  422. sub-process.c
  423. sub-process.h
  424. submodule-config.c
  425. submodule-config.h
  426. submodule.c
  427. submodule.h
  428. symlinks.c
  429. tag.c
  430. tag.h
  431. tar.h
  432. tempfile.c
  433. tempfile.h
  434. thread-utils.c
  435. thread-utils.h
  436. tmp-objdir.c
  437. tmp-objdir.h
  438. trace.c
  439. trace.h
  440. trace2.c
  441. trace2.h
  442. trailer.c
  443. trailer.h
  444. transport-helper.c
  445. transport-internal.h
  446. transport.c
  447. transport.h
  448. tree-diff.c
  449. tree-walk.c
  450. tree-walk.h
  451. tree.c
  452. tree.h
  453. unicode-width.h
  454. unimplemented.sh
  455. unix-socket.c
  456. unix-socket.h
  457. unix-stream-server.c
  458. unix-stream-server.h
  459. unpack-trees.c
  460. unpack-trees.h
  461. upload-pack.c
  462. upload-pack.h
  463. url.c
  464. url.h
  465. urlmatch.c
  466. urlmatch.h
  467. usage.c
  468. userdiff.c
  469. userdiff.h
  470. utf8.c
  471. utf8.h
  472. varint.c
  473. varint.h
  474. version.c
  475. version.h
  476. versioncmp.c
  477. walker.c
  478. walker.h
  479. wildmatch.c
  480. wildmatch.h
  481. worktree.c
  482. worktree.h
  483. wrap-for-bin.sh
  484. wrapper.c
  485. write-or-die.c
  486. ws.c
  487. wt-status.c
  488. wt-status.h
  489. xdiff-interface.c
  490. xdiff-interface.h
  491. 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