mirror of
https://github.com/git/git.git
synced 2026-08-08 17:11:48 +00:00
42824db113
Blame and "git log --stat" recover hunk coordinates by diffing blob pairs, and recompute them on every run. Add a cache of those coordinates at $GIT_DIR/objects/info/diff-hunks, beside the commit-graph, so a later run can look them up instead of decompressing the blobs and running xdiff again. The store is a single chunk-format file (see gitformat-chunk(5)): an 8-byte header, a DHIX index of fixed-size entries sorted by key, a DHDT segment of hunk records, and a trailing hash checksum. An entry is keyed by the two blob object ids and the xdl_opts the pair was diffed under, so a stored result is served only where that exact key recurs, independent of path. A zero-context diff trims unchanged lines from hunk edges and can pick a different but equally valid set of hunks than an untrimmed diff, so a recording caller stores a pair only when its trimmed and untrimmed diffs are identical; such an entry answers any consumer at any context, and the rare divergent pair is always computed. Identical hunk blocks are interned once and shared across keys. The library provides a reader (repo_diff_hunks_store and _replay, gated by core.diffHunks), loaded once and cached on the object database as the commit-graph is, and a writer that accumulates entries and flushes them in one atomic pass. An absent, corrupt, or disabled store reads as all misses. A record with no hunks is invalid too: replaying it would claim the pair equivalent, which the store never asserts, so it reads as a miss. Ordinary reads are diagnostic-free. Loading parses the chunk table through read_table_of_contents_quiet(), new in chunk-format, which prints nothing on a malformed table and takes the repository's hash algorithm rather than the_hash_algo, so the file is bounds-checked under the algorithm it is keyed by. The flush closes the repository's mmapped store and forgets that loading was attempted before committing the lockfile. A warming run that also reads may hold the file it is replacing mapped, and the rename must not land on a live mapping, which Windows refuses; a read after the flush then observes the committed file. commit-graph closes its graph before committing for the same reason. Writing is off by default, enabled per run by GIT_DIFF_HUNKS_WRITE or persistently by diffHunks.write, the environment winning. A writer seeds from the existing store, so a flush merges rather than replaces. The seed's checksum is verified first: a corrupt store is discarded, not rewritten with a fresh checksum verify could no longer catch. An entry that fails the shared diff_provider_check_hunk() or names no blob is dropped with a warning, since it would only ever read as a miss. A seed that discarded or dropped anything forces the flush even when the warming run computed nothing new. The writer fsyncs through a new diff-hunks core.fsync component. "git diff-hunks" inspects and manages the file: "verify" checks the checksum, chunk table, sort order, entry bounds, and every entry's hunk sequence against that shared check, so a store whose entries could only read as misses fails verify; "clear" removes the file. Later patches wire the readers and the writer into the diff and blame paths. Signed-off-by: Michael Montalbo <mmontalbo@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
290 lines
18 KiB
C
290 lines
18 KiB
C
#ifndef BUILTIN_H
|
|
#define BUILTIN_H
|
|
|
|
#include "git-compat-util.h"
|
|
#include "repository.h"
|
|
|
|
/*
|
|
* builtin API
|
|
* ===========
|
|
*
|
|
* Adding a new built-in
|
|
* ---------------------
|
|
*
|
|
* There are 4 things to do to add a built-in command implementation to
|
|
* Git:
|
|
*
|
|
* . Define the implementation of the built-in command `foo` with
|
|
* signature:
|
|
*
|
|
* int cmd_foo(int argc, const char **argv,
|
|
* const char *prefix, struct repository *repo);
|
|
*
|
|
* . Add the external declaration for the function to `builtin.h`.
|
|
*
|
|
* . Add the command to the `commands[]` table defined in `git.c`.
|
|
* The entry should look like:
|
|
*
|
|
* { "foo", cmd_foo, <options> },
|
|
*
|
|
* where options is the bitwise-or of:
|
|
*
|
|
* `RUN_SETUP`:
|
|
*
|
|
* If there is not a Git directory to work on, abort. If there
|
|
* is a work tree, chdir to the top of it if the command was
|
|
* invoked in a subdirectory. If there is no work tree, no
|
|
* chdir() is done.
|
|
*
|
|
* `RUN_SETUP_GENTLY`:
|
|
*
|
|
* If there is a Git directory, chdir as per RUN_SETUP, otherwise,
|
|
* don't chdir anywhere.
|
|
*
|
|
* `USE_PAGER`:
|
|
*
|
|
* If the standard output is connected to a tty, spawn a pager and
|
|
* feed our output to it.
|
|
*
|
|
* `NEED_WORK_TREE`:
|
|
*
|
|
* Make sure there is a work tree, i.e. the command cannot act
|
|
* on bare repositories.
|
|
* This only makes sense when `RUN_SETUP` is also set.
|
|
*
|
|
* `DELAY_PAGER_CONFIG`:
|
|
*
|
|
* If RUN_SETUP or RUN_SETUP_GENTLY is set, git.c normally handles
|
|
* the `pager.<cmd>`-configuration. If this flag is used, git.c
|
|
* will skip that step, instead allowing the built-in to make a
|
|
* more informed decision, e.g., by ignoring `pager.<cmd>` for
|
|
* certain subcommands.
|
|
*
|
|
* `NO_PARSEOPT`:
|
|
*
|
|
* Most Git builtins use the parseopt library for parsing options.
|
|
* This flag indicates that a custom parser is used and thus the
|
|
* builtin would not appear in 'git --list-cmds=parseopt'.
|
|
*
|
|
* . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
|
|
*
|
|
* Additionally, if `foo` is a new command, there are 4 more things to do:
|
|
*
|
|
* . Add tests to `t/` directory.
|
|
*
|
|
* . Write documentation in `Documentation/git-foo.adoc`.
|
|
*
|
|
* . Add an entry for `git-foo` to `command-list.txt`.
|
|
*
|
|
* . Add an entry for `/git-foo` to `.gitignore`.
|
|
*
|
|
* As you work on implementing your builtin, be mindful that the
|
|
* following tests will check different aspects of the builtin's
|
|
* readiness and adherence to matching the documentation:
|
|
*
|
|
* * t0012-help.sh checks that the builtin can handle -h, which comes
|
|
* automatically with the parseopt API.
|
|
*
|
|
* * t0450-txt-doc-vs-help.sh checks that the -h help output matches the
|
|
* SYNOPSIS in the documentation for the builtin.
|
|
*
|
|
* * t1517-outside-repo.sh checks that the builtin can handle -h when
|
|
* run outside of the context of a repository. Note that this test
|
|
* requires that the usage has a space after the builtin name, so some
|
|
* minimum description of options is required.
|
|
*
|
|
*
|
|
* How a built-in is called
|
|
* ------------------------
|
|
*
|
|
* The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
|
|
* and `prefix`. The first two are similar to what `main()` of a
|
|
* standalone command would be called with.
|
|
*
|
|
* When `RUN_SETUP` is specified in the `commands[]` table, and when you
|
|
* were started from a subdirectory of the work tree, `cmd_foo()` is called
|
|
* after chdir(2) to the top of the work tree, and `prefix` gets the path
|
|
* to the subdirectory the command started from. This allows you to
|
|
* convert a user-supplied pathname (typically relative to that directory)
|
|
* to a pathname relative to the top of the work tree.
|
|
*
|
|
* The return value from `cmd_foo()` becomes the exit status of the
|
|
* command.
|
|
*/
|
|
|
|
extern const char git_usage_string[];
|
|
extern const char git_more_info_string[];
|
|
|
|
/**
|
|
* If a built-in has DELAY_PAGER_CONFIG set, the built-in should call this early
|
|
* when it wishes to respect the `pager.foo`-config. The `cmd` is the name of
|
|
* the built-in, e.g., "foo". If a paging-choice has already been setup, this
|
|
* does nothing. The default in `def` should be 0 for "pager off", 1 for "pager
|
|
* on" or -1 for "punt".
|
|
*
|
|
* You should most likely use a default of 0 or 1. "Punt" (-1) could be useful
|
|
* to be able to fall back to some historical compatibility name.
|
|
*/
|
|
void setup_auto_pager(const char *cmd, int def);
|
|
|
|
int is_builtin(const char *s);
|
|
|
|
/*
|
|
* Builtins which do not use RUN_SETUP should never see
|
|
* a prefix that is not empty; use this to protect downstream
|
|
* code which is not prepared to call prefix_filename(), etc.
|
|
*/
|
|
#define BUG_ON_NON_EMPTY_PREFIX(prefix) do { \
|
|
if ((prefix)) \
|
|
BUG("unexpected prefix in builtin: %s", (prefix)); \
|
|
} while (0)
|
|
|
|
int cmd_add(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_am(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_annotate(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_apply(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_archive(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_backfill(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_bisect(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_blame(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_branch(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_bugreport(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_bundle(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_cat_file(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_checkout(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_checkout__worker(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_checkout_index(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_check_attr(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_check_ignore(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_check_mailmap(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_check_ref_format(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_cherry(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_cherry_pick(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_clone(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_clean(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_column(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_commit(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_commit_graph(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_commit_tree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_config(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_count_objects(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_credential(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_credential_cache(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_credential_cache_daemon(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_credential_store(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_describe(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_diagnose(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_diff_files(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_diff_hunks(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_diff_index(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_diff(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_diff_pairs(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_diff_tree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_difftool(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_env__helper(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_fast_export(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_fast_import(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_fetch(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_fetch_pack(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_for_each_ref(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_for_each_repo(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_format_patch(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_format_rev(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_fsck(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_fsmonitor__daemon(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_gc(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_grep(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_hash_object(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_help(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_history(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_hook(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_index_pack(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_init_db(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_interpret_trailers(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_last_modified(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_log_reflog(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_log(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_ls_files(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_ls_tree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_ls_remote(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_mailinfo(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_mailsplit(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_maintenance(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_merge(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_merge_base(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_merge_index(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_merge_ours(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_merge_file(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_merge_recursive(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_merge_tree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_mktag(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_mktree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_multi_pack_index(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_mv(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_name_rev(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_notes(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_pack_objects(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_pack_redundant(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_patch_id(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_prune(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_prune_packed(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_pull(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_push(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_range_diff(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_read_tree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_rebase(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_rebase__interactive(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_receive_pack(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_reflog(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_refs(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_remote(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_remote_ext(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_remote_fd(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_repack(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_replay(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_repo(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_rerere(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_reset(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_restore(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_rev_list(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_rev_parse(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_revert(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_rm(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_send_pack(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_shortlog(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_show(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_show_branch(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_show_index(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_sparse_checkout(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_status(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_stash(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_stripspace(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_submodule__helper(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_switch(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_symbolic_ref(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_tag(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_unpack_file(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_unpack_objects(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_update_index(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_update_ref(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_update_server_info(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_upload_archive(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_upload_pack(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_url_parse(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_var(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_verify_commit(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_verify_tag(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_version(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_whatchanged(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_worktree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_write_tree(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_verify_pack(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_show_ref(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_pack_refs(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
int cmd_replace(int argc, const char **argv, const char *prefix, struct repository *repo);
|
|
|
|
#endif
|