cache.hon commit Git.pm: fix example in command_close_bidi_pipe documentation (8a2cc51)
   1#ifndef CACHE_H
   2#define CACHE_H
   3
   4#include "git-compat-util.h"
   5#include "strbuf.h"
   6#include "hash.h"
   7#include "advice.h"
   8#include "gettext.h"
   9#include "convert.h"
  10
  11#include SHA1_HEADER
  12#ifndef git_SHA_CTX
  13#define git_SHA_CTX     SHA_CTX
  14#define git_SHA1_Init   SHA1_Init
  15#define git_SHA1_Update SHA1_Update
  16#define git_SHA1_Final  SHA1_Final
  17#endif
  18
  19#include <zlib.h>
  20typedef struct git_zstream {
  21        z_stream z;
  22        unsigned long avail_in;
  23        unsigned long avail_out;
  24        unsigned long total_in;
  25        unsigned long total_out;
  26        unsigned char *next_in;
  27        unsigned char *next_out;
  28} git_zstream;
  29
  30void git_inflate_init(git_zstream *);
  31void git_inflate_init_gzip_only(git_zstream *);
  32void git_inflate_end(git_zstream *);
  33int git_inflate(git_zstream *, int flush);
  34
  35void git_deflate_init(git_zstream *, int level);
  36void git_deflate_init_gzip(git_zstream *, int level);
  37void git_deflate_end(git_zstream *);
  38int git_deflate_abort(git_zstream *);
  39int git_deflate_end_gently(git_zstream *);
  40int git_deflate(git_zstream *, int flush);
  41unsigned long git_deflate_bound(git_zstream *, unsigned long);
  42
  43#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  44#define DTYPE(de)       ((de)->d_type)
  45#else
  46#undef DT_UNKNOWN
  47#undef DT_DIR
  48#undef DT_REG
  49#undef DT_LNK
  50#define DT_UNKNOWN      0
  51#define DT_DIR          1
  52#define DT_REG          2
  53#define DT_LNK          3
  54#define DTYPE(de)       DT_UNKNOWN
  55#endif
  56
  57/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
  58#define S_IFINVALID     0030000
  59
  60/*
  61 * A "directory link" is a link to another git directory.
  62 *
  63 * The value 0160000 is not normally a valid mode, and
  64 * also just happens to be S_IFDIR + S_IFLNK
  65 *
  66 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
  67 * always having the same values everywhere. We should use
  68 * our internal git values for these things, and then we can
  69 * translate that to the OS-specific value. It just so
  70 * happens that everybody shares the same bit representation
  71 * in the UNIX world (and apparently wider too..)
  72 */
  73#define S_IFGITLINK     0160000
  74#define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
  75
  76/*
  77 * Intensive research over the course of many years has shown that
  78 * port 9418 is totally unused by anything else. Or
  79 *
  80 *      Your search - "port 9418" - did not match any documents.
  81 *
  82 * as www.google.com puts it.
  83 *
  84 * This port has been properly assigned for git use by IANA:
  85 * git (Assigned-9418) [I06-050728-0001].
  86 *
  87 *      git  9418/tcp   git pack transfer service
  88 *      git  9418/udp   git pack transfer service
  89 *
  90 * with Linus Torvalds <torvalds@osdl.org> as the point of
  91 * contact. September 2005.
  92 *
  93 * See http://www.iana.org/assignments/port-numbers
  94 */
  95#define DEFAULT_GIT_PORT 9418
  96
  97/*
  98 * Basic data structures for the directory cache
  99 */
 100
 101#define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
 102struct cache_header {
 103        unsigned int hdr_signature;
 104        unsigned int hdr_version;
 105        unsigned int hdr_entries;
 106};
 107
 108#define INDEX_FORMAT_LB 2
 109#define INDEX_FORMAT_UB 4
 110
 111/*
 112 * The "cache_time" is just the low 32 bits of the
 113 * time. It doesn't matter if it overflows - we only
 114 * check it for equality in the 32 bits we save.
 115 */
 116struct cache_time {
 117        unsigned int sec;
 118        unsigned int nsec;
 119};
 120
 121struct cache_entry {
 122        struct cache_time ce_ctime;
 123        struct cache_time ce_mtime;
 124        unsigned int ce_dev;
 125        unsigned int ce_ino;
 126        unsigned int ce_mode;
 127        unsigned int ce_uid;
 128        unsigned int ce_gid;
 129        unsigned int ce_size;
 130        unsigned int ce_flags;
 131        unsigned int ce_namelen;
 132        unsigned char sha1[20];
 133        struct cache_entry *next;
 134        struct cache_entry *dir_next;
 135        char name[FLEX_ARRAY]; /* more */
 136};
 137
 138#define CE_STAGEMASK (0x3000)
 139#define CE_EXTENDED  (0x4000)
 140#define CE_VALID     (0x8000)
 141#define CE_STAGESHIFT 12
 142
 143/*
 144 * Range 0xFFFF0000 in ce_flags is divided into
 145 * two parts: in-memory flags and on-disk ones.
 146 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
 147 * if you want to save a new flag, add it in
 148 * CE_EXTENDED_FLAGS
 149 *
 150 * In-memory only flags
 151 */
 152#define CE_UPDATE            (1 << 16)
 153#define CE_REMOVE            (1 << 17)
 154#define CE_UPTODATE          (1 << 18)
 155#define CE_ADDED             (1 << 19)
 156
 157#define CE_HASHED            (1 << 20)
 158#define CE_UNHASHED          (1 << 21)
 159#define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
 160#define CE_CONFLICTED        (1 << 23)
 161
 162#define CE_UNPACKED          (1 << 24)
 163#define CE_NEW_SKIP_WORKTREE (1 << 25)
 164
 165/*
 166 * Extended on-disk flags
 167 */
 168#define CE_INTENT_TO_ADD     (1 << 29)
 169#define CE_SKIP_WORKTREE     (1 << 30)
 170/* CE_EXTENDED2 is for future extension */
 171#define CE_EXTENDED2         (1 << 31)
 172
 173#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
 174
 175/*
 176 * Safeguard to avoid saving wrong flags:
 177 *  - CE_EXTENDED2 won't get saved until its semantic is known
 178 *  - Bits in 0x0000FFFF have been saved in ce_flags already
 179 *  - Bits in 0x003F0000 are currently in-memory flags
 180 */
 181#if CE_EXTENDED_FLAGS & 0x803FFFFF
 182#error "CE_EXTENDED_FLAGS out of range"
 183#endif
 184
 185/*
 186 * Copy the sha1 and stat state of a cache entry from one to
 187 * another. But we never change the name, or the hash state!
 188 */
 189#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
 190static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
 191{
 192        unsigned int state = dst->ce_flags & CE_STATE_MASK;
 193
 194        /* Don't copy hash chain and name */
 195        memcpy(dst, src, offsetof(struct cache_entry, next));
 196
 197        /* Restore the hash state */
 198        dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
 199}
 200
 201static inline unsigned create_ce_flags(unsigned stage)
 202{
 203        return (stage << CE_STAGESHIFT);
 204}
 205
 206#define ce_namelen(ce) ((ce)->ce_namelen)
 207#define ce_size(ce) cache_entry_size(ce_namelen(ce))
 208#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
 209#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
 210#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
 211#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
 212
 213#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 214static inline unsigned int create_ce_mode(unsigned int mode)
 215{
 216        if (S_ISLNK(mode))
 217                return S_IFLNK;
 218        if (S_ISDIR(mode) || S_ISGITLINK(mode))
 219                return S_IFGITLINK;
 220        return S_IFREG | ce_permissions(mode);
 221}
 222static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
 223{
 224        extern int trust_executable_bit, has_symlinks;
 225        if (!has_symlinks && S_ISREG(mode) &&
 226            ce && S_ISLNK(ce->ce_mode))
 227                return ce->ce_mode;
 228        if (!trust_executable_bit && S_ISREG(mode)) {
 229                if (ce && S_ISREG(ce->ce_mode))
 230                        return ce->ce_mode;
 231                return create_ce_mode(0666);
 232        }
 233        return create_ce_mode(mode);
 234}
 235static inline int ce_to_dtype(const struct cache_entry *ce)
 236{
 237        unsigned ce_mode = ntohl(ce->ce_mode);
 238        if (S_ISREG(ce_mode))
 239                return DT_REG;
 240        else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
 241                return DT_DIR;
 242        else if (S_ISLNK(ce_mode))
 243                return DT_LNK;
 244        else
 245                return DT_UNKNOWN;
 246}
 247static inline unsigned int canon_mode(unsigned int mode)
 248{
 249        if (S_ISREG(mode))
 250                return S_IFREG | ce_permissions(mode);
 251        if (S_ISLNK(mode))
 252                return S_IFLNK;
 253        if (S_ISDIR(mode))
 254                return S_IFDIR;
 255        return S_IFGITLINK;
 256}
 257
 258#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
 259
 260struct index_state {
 261        struct cache_entry **cache;
 262        unsigned int version;
 263        unsigned int cache_nr, cache_alloc, cache_changed;
 264        struct string_list *resolve_undo;
 265        struct cache_tree *cache_tree;
 266        struct cache_time timestamp;
 267        unsigned name_hash_initialized : 1,
 268                 initialized : 1;
 269        struct hash_table name_hash;
 270};
 271
 272extern struct index_state the_index;
 273
 274/* Name hashing */
 275extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
 276/*
 277 * We don't actually *remove* it, we can just mark it invalid so that
 278 * we won't find it in lookups.
 279 *
 280 * Not only would we have to search the lists (simple enough), but
 281 * we'd also have to rehash other hash buckets in case this makes the
 282 * hash bucket empty (common). So it's much better to just mark
 283 * it.
 284 */
 285static inline void remove_name_hash(struct cache_entry *ce)
 286{
 287        ce->ce_flags |= CE_UNHASHED;
 288}
 289
 290
 291#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
 292#define active_cache (the_index.cache)
 293#define active_nr (the_index.cache_nr)
 294#define active_alloc (the_index.cache_alloc)
 295#define active_cache_changed (the_index.cache_changed)
 296#define active_cache_tree (the_index.cache_tree)
 297
 298#define read_cache() read_index(&the_index)
 299#define read_cache_from(path) read_index_from(&the_index, (path))
 300#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
 301#define is_cache_unborn() is_index_unborn(&the_index)
 302#define read_cache_unmerged() read_index_unmerged(&the_index)
 303#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
 304#define discard_cache() discard_index(&the_index)
 305#define unmerged_cache() unmerged_index(&the_index)
 306#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 307#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 308#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
 309#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 310#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 311#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
 312#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
 313#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
 314#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 315#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 316#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
 317#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
 318#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
 319#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
 320#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
 321#endif
 322
 323enum object_type {
 324        OBJ_BAD = -1,
 325        OBJ_NONE = 0,
 326        OBJ_COMMIT = 1,
 327        OBJ_TREE = 2,
 328        OBJ_BLOB = 3,
 329        OBJ_TAG = 4,
 330        /* 5 for future expansion */
 331        OBJ_OFS_DELTA = 6,
 332        OBJ_REF_DELTA = 7,
 333        OBJ_ANY,
 334        OBJ_MAX
 335};
 336
 337static inline enum object_type object_type(unsigned int mode)
 338{
 339        return S_ISDIR(mode) ? OBJ_TREE :
 340                S_ISGITLINK(mode) ? OBJ_COMMIT :
 341                OBJ_BLOB;
 342}
 343
 344#define GIT_DIR_ENVIRONMENT "GIT_DIR"
 345#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
 346#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 347#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 348#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 349#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 350#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 351#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 352#define CONFIG_ENVIRONMENT "GIT_CONFIG"
 353#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
 354#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 355#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
 356#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
 357#define GITATTRIBUTES_FILE ".gitattributes"
 358#define INFOATTRIBUTES_FILE "info/attributes"
 359#define ATTRIBUTE_MACRO_PREFIX "[attr]"
 360#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
 361#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
 362#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
 363#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
 364#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
 365#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
 366
 367/*
 368 * Repository-local GIT_* environment variables
 369 * The array is NULL-terminated to simplify its usage in contexts such
 370 * environment creation or simple walk of the list.
 371 * The number of non-NULL entries is available as a macro.
 372 */
 373#define LOCAL_REPO_ENV_SIZE 9
 374extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
 375
 376extern int is_bare_repository_cfg;
 377extern int is_bare_repository(void);
 378extern int is_inside_git_dir(void);
 379extern char *git_work_tree_cfg;
 380extern int is_inside_work_tree(void);
 381extern int have_git_dir(void);
 382extern const char *get_git_dir(void);
 383extern int is_git_directory(const char *path);
 384extern char *get_object_directory(void);
 385extern char *get_index_file(void);
 386extern char *get_graft_file(void);
 387extern int set_git_dir(const char *path);
 388extern const char *get_git_namespace(void);
 389extern const char *strip_namespace(const char *namespaced_ref);
 390extern const char *get_git_work_tree(void);
 391extern const char *read_gitfile(const char *path);
 392extern const char *resolve_gitdir(const char *suspect);
 393extern void set_git_work_tree(const char *tree);
 394
 395#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 396
 397extern const char **get_pathspec(const char *prefix, const char **pathspec);
 398extern void setup_work_tree(void);
 399extern const char *setup_git_directory_gently(int *);
 400extern const char *setup_git_directory(void);
 401extern char *prefix_path(const char *prefix, int len, const char *path);
 402extern const char *prefix_filename(const char *prefix, int len, const char *path);
 403extern int check_filename(const char *prefix, const char *name);
 404extern void verify_filename(const char *prefix,
 405                            const char *name,
 406                            int diagnose_misspelt_rev);
 407extern void verify_non_filename(const char *prefix, const char *name);
 408extern int path_inside_repo(const char *prefix, const char *path);
 409
 410#define INIT_DB_QUIET 0x0001
 411
 412extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
 413extern int init_db(const char *template_dir, unsigned int flags);
 414
 415#define alloc_nr(x) (((x)+16)*3/2)
 416
 417/*
 418 * Realloc the buffer pointed at by variable 'x' so that it can hold
 419 * at least 'nr' entries; the number of entries currently allocated
 420 * is 'alloc', using the standard growing factor alloc_nr() macro.
 421 *
 422 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
 423 */
 424#define ALLOC_GROW(x, nr, alloc) \
 425        do { \
 426                if ((nr) > alloc) { \
 427                        if (alloc_nr(alloc) < (nr)) \
 428                                alloc = (nr); \
 429                        else \
 430                                alloc = alloc_nr(alloc); \
 431                        x = xrealloc((x), alloc * sizeof(*(x))); \
 432                } \
 433        } while (0)
 434
 435/* Initialize and use the cache information */
 436extern int read_index(struct index_state *);
 437extern int read_index_preload(struct index_state *, const char **pathspec);
 438extern int read_index_from(struct index_state *, const char *path);
 439extern int is_index_unborn(struct index_state *);
 440extern int read_index_unmerged(struct index_state *);
 441extern int write_index(struct index_state *, int newfd);
 442extern int discard_index(struct index_state *);
 443extern int unmerged_index(const struct index_state *);
 444extern int verify_path(const char *path);
 445extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 446extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 447#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 448#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 449#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 450#define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 451#define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
 452extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 453extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
 454extern int remove_index_entry_at(struct index_state *, int pos);
 455extern void remove_marked_cache_entries(struct index_state *istate);
 456extern int remove_file_from_index(struct index_state *, const char *path);
 457#define ADD_CACHE_VERBOSE 1
 458#define ADD_CACHE_PRETEND 2
 459#define ADD_CACHE_IGNORE_ERRORS 4
 460#define ADD_CACHE_IGNORE_REMOVAL 8
 461#define ADD_CACHE_INTENT 16
 462extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
 463extern int add_file_to_index(struct index_state *, const char *path, int flags);
 464extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
 465extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 466extern int index_name_is_other(const struct index_state *, const char *, int);
 467
 468/* do stat comparison even if CE_VALID is true */
 469#define CE_MATCH_IGNORE_VALID           01
 470/* do not check the contents but report dirty on racily-clean entries */
 471#define CE_MATCH_RACY_IS_DIRTY          02
 472/* do stat comparison even if CE_SKIP_WORKTREE is true */
 473#define CE_MATCH_IGNORE_SKIP_WORKTREE   04
 474extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 475extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 476
 477#define PATHSPEC_ONESTAR 1      /* the pathspec pattern sastisfies GFNM_ONESTAR */
 478
 479struct pathspec {
 480        const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
 481        int nr;
 482        unsigned int has_wildcard:1;
 483        unsigned int recursive:1;
 484        int max_depth;
 485        struct pathspec_item {
 486                const char *match;
 487                int len;
 488                int nowildcard_len;
 489                int flags;
 490        } *items;
 491};
 492
 493extern int init_pathspec(struct pathspec *, const char **);
 494extern void free_pathspec(struct pathspec *);
 495extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
 496
 497extern int limit_pathspec_to_literal(void);
 498
 499#define HASH_WRITE_OBJECT 1
 500#define HASH_FORMAT_CHECK 2
 501extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
 502extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
 503extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 504
 505#define REFRESH_REALLY          0x0001  /* ignore_valid */
 506#define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 507#define REFRESH_QUIET           0x0004  /* be quiet about it */
 508#define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 509#define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
 510#define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
 511extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
 512
 513struct lock_file {
 514        struct lock_file *next;
 515        int fd;
 516        pid_t owner;
 517        char on_list;
 518        char filename[PATH_MAX];
 519};
 520#define LOCK_DIE_ON_ERROR 1
 521#define LOCK_NODEREF 2
 522extern int unable_to_lock_error(const char *path, int err);
 523extern NORETURN void unable_to_lock_index_die(const char *path, int err);
 524extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 525extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
 526extern int commit_lock_file(struct lock_file *);
 527extern void update_index_if_able(struct index_state *, struct lock_file *);
 528
 529extern int hold_locked_index(struct lock_file *, int);
 530extern int commit_locked_index(struct lock_file *);
 531extern void set_alternate_index_output(const char *);
 532extern int close_lock_file(struct lock_file *);
 533extern void rollback_lock_file(struct lock_file *);
 534extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
 535
 536/* Environment bits from configuration mechanism */
 537extern int trust_executable_bit;
 538extern int trust_ctime;
 539extern int check_stat;
 540extern int quote_path_fully;
 541extern int has_symlinks;
 542extern int minimum_abbrev, default_abbrev;
 543extern int ignore_case;
 544extern int assume_unchanged;
 545extern int prefer_symlink_refs;
 546extern int log_all_ref_updates;
 547extern int warn_ambiguous_refs;
 548extern int shared_repository;
 549extern const char *apply_default_whitespace;
 550extern const char *apply_default_ignorewhitespace;
 551extern const char *git_attributes_file;
 552extern int zlib_compression_level;
 553extern int core_compression_level;
 554extern int core_compression_seen;
 555extern size_t packed_git_window_size;
 556extern size_t packed_git_limit;
 557extern size_t delta_base_cache_limit;
 558extern unsigned long big_file_threshold;
 559extern unsigned long pack_size_limit_cfg;
 560extern int read_replace_refs;
 561extern int fsync_object_files;
 562extern int core_preload_index;
 563extern int core_apply_sparse_checkout;
 564extern int precomposed_unicode;
 565
 566/*
 567 * The character that begins a commented line in user-editable file
 568 * that is subject to stripspace.
 569 */
 570extern char comment_line_char;
 571
 572enum branch_track {
 573        BRANCH_TRACK_UNSPECIFIED = -1,
 574        BRANCH_TRACK_NEVER = 0,
 575        BRANCH_TRACK_REMOTE,
 576        BRANCH_TRACK_ALWAYS,
 577        BRANCH_TRACK_EXPLICIT,
 578        BRANCH_TRACK_OVERRIDE
 579};
 580
 581enum rebase_setup_type {
 582        AUTOREBASE_NEVER = 0,
 583        AUTOREBASE_LOCAL,
 584        AUTOREBASE_REMOTE,
 585        AUTOREBASE_ALWAYS
 586};
 587
 588enum push_default_type {
 589        PUSH_DEFAULT_NOTHING = 0,
 590        PUSH_DEFAULT_MATCHING,
 591        PUSH_DEFAULT_SIMPLE,
 592        PUSH_DEFAULT_UPSTREAM,
 593        PUSH_DEFAULT_CURRENT,
 594        PUSH_DEFAULT_UNSPECIFIED
 595};
 596
 597extern enum branch_track git_branch_track;
 598extern enum rebase_setup_type autorebase;
 599extern enum push_default_type push_default;
 600
 601enum object_creation_mode {
 602        OBJECT_CREATION_USES_HARDLINKS = 0,
 603        OBJECT_CREATION_USES_RENAMES = 1
 604};
 605
 606extern enum object_creation_mode object_creation_mode;
 607
 608extern char *notes_ref_name;
 609
 610extern int grafts_replace_parents;
 611
 612#define GIT_REPO_VERSION 0
 613extern int repository_format_version;
 614extern int check_repository_format(void);
 615
 616#define MTIME_CHANGED   0x0001
 617#define CTIME_CHANGED   0x0002
 618#define OWNER_CHANGED   0x0004
 619#define MODE_CHANGED    0x0008
 620#define INODE_CHANGED   0x0010
 621#define DATA_CHANGED    0x0020
 622#define TYPE_CHANGED    0x0040
 623
 624extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
 625        __attribute__((format (printf, 3, 4)));
 626extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
 627        __attribute__((format (printf, 3, 4)));
 628extern char *git_pathdup(const char *fmt, ...)
 629        __attribute__((format (printf, 1, 2)));
 630extern char *mkpathdup(const char *fmt, ...)
 631        __attribute__((format (printf, 1, 2)));
 632
 633/* Return a statically allocated filename matching the sha1 signature */
 634extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 635extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 636extern char *git_path_submodule(const char *path, const char *fmt, ...)
 637        __attribute__((format (printf, 2, 3)));
 638
 639extern char *sha1_file_name(const unsigned char *sha1);
 640extern char *sha1_pack_name(const unsigned char *sha1);
 641extern char *sha1_pack_index_name(const unsigned char *sha1);
 642extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 643extern const unsigned char null_sha1[20];
 644
 645static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 646{
 647        int i;
 648
 649        for (i = 0; i < 20; i++, sha1++, sha2++) {
 650                if (*sha1 != *sha2)
 651                        return *sha1 - *sha2;
 652        }
 653
 654        return 0;
 655}
 656
 657static inline int is_null_sha1(const unsigned char *sha1)
 658{
 659        return !hashcmp(sha1, null_sha1);
 660}
 661
 662static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 663{
 664        memcpy(sha_dst, sha_src, 20);
 665}
 666static inline void hashclr(unsigned char *hash)
 667{
 668        memset(hash, 0, 20);
 669}
 670
 671#define EMPTY_TREE_SHA1_HEX \
 672        "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 673#define EMPTY_TREE_SHA1_BIN_LITERAL \
 674         "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
 675         "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
 676#define EMPTY_TREE_SHA1_BIN \
 677         ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
 678
 679#define EMPTY_BLOB_SHA1_HEX \
 680        "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
 681#define EMPTY_BLOB_SHA1_BIN_LITERAL \
 682        "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
 683        "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
 684#define EMPTY_BLOB_SHA1_BIN \
 685        ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
 686
 687static inline int is_empty_blob_sha1(const unsigned char *sha1)
 688{
 689        return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
 690}
 691
 692int git_mkstemp(char *path, size_t n, const char *template);
 693
 694int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
 695
 696/* set default permissions by passing mode arguments to open(2) */
 697int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
 698int git_mkstemp_mode(char *pattern, int mode);
 699
 700/*
 701 * NOTE NOTE NOTE!!
 702 *
 703 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 704 * not be changed. Old repositories have core.sharedrepository written in
 705 * numeric format, and therefore these values are preserved for compatibility
 706 * reasons.
 707 */
 708enum sharedrepo {
 709        PERM_UMASK          = 0,
 710        OLD_PERM_GROUP      = 1,
 711        OLD_PERM_EVERYBODY  = 2,
 712        PERM_GROUP          = 0660,
 713        PERM_EVERYBODY      = 0664
 714};
 715int git_config_perm(const char *var, const char *value);
 716int set_shared_perm(const char *path, int mode);
 717#define adjust_shared_perm(path) set_shared_perm((path), 0)
 718int safe_create_leading_directories(char *path);
 719int safe_create_leading_directories_const(const char *path);
 720int mkdir_in_gitdir(const char *path);
 721extern void home_config_paths(char **global, char **xdg, char *file);
 722extern char *expand_user_path(const char *path);
 723const char *enter_repo(const char *path, int strict);
 724static inline int is_absolute_path(const char *path)
 725{
 726        return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
 727}
 728int is_directory(const char *);
 729const char *real_path(const char *path);
 730const char *real_path_if_valid(const char *path);
 731const char *absolute_path(const char *path);
 732const char *relative_path(const char *abs, const char *base);
 733int normalize_path_copy(char *dst, const char *src);
 734int longest_ancestor_length(const char *path, struct string_list *prefixes);
 735char *strip_path_suffix(const char *path, const char *suffix);
 736int daemon_avoid_alias(const char *path);
 737int offset_1st_component(const char *path);
 738
 739/* object replacement */
 740#define READ_SHA1_FILE_REPLACE 1
 741extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
 742static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
 743{
 744        return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
 745}
 746extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
 747static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
 748{
 749        if (!read_replace_refs)
 750                return sha1;
 751        return do_lookup_replace_object(sha1);
 752}
 753
 754/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 755extern int sha1_object_info(const unsigned char *, unsigned long *);
 756extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 757extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 758extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 759extern int force_object_loose(const unsigned char *sha1, time_t mtime);
 760extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
 761extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
 762extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
 763
 764/* global flag to enable extra checks when accessing packed objects */
 765extern int do_check_packed_object_crc;
 766
 767/* for development: log offset of pack access */
 768extern const char *log_pack_access;
 769
 770extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 771
 772extern int move_temp_to_file(const char *tmpfile, const char *filename);
 773
 774extern int has_sha1_pack(const unsigned char *sha1);
 775extern int has_sha1_file(const unsigned char *sha1);
 776extern int has_loose_object_nonlocal(const unsigned char *sha1);
 777
 778extern int has_pack_index(const unsigned char *sha1);
 779
 780extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
 781
 782extern const signed char hexval_table[256];
 783static inline unsigned int hexval(unsigned char c)
 784{
 785        return hexval_table[c];
 786}
 787
 788/* Convert to/from hex/sha1 representation */
 789#define MINIMUM_ABBREV minimum_abbrev
 790#define DEFAULT_ABBREV default_abbrev
 791
 792struct object_context {
 793        unsigned char tree[20];
 794        char path[PATH_MAX];
 795        unsigned mode;
 796};
 797
 798#define GET_SHA1_QUIETLY        01
 799#define GET_SHA1_COMMIT         02
 800#define GET_SHA1_COMMITTISH     04
 801#define GET_SHA1_TREE          010
 802#define GET_SHA1_TREEISH       020
 803#define GET_SHA1_BLOB          040
 804#define GET_SHA1_ONLY_TO_DIE 04000
 805
 806extern int get_sha1(const char *str, unsigned char *sha1);
 807extern int get_sha1_commit(const char *str, unsigned char *sha1);
 808extern int get_sha1_committish(const char *str, unsigned char *sha1);
 809extern int get_sha1_tree(const char *str, unsigned char *sha1);
 810extern int get_sha1_treeish(const char *str, unsigned char *sha1);
 811extern int get_sha1_blob(const char *str, unsigned char *sha1);
 812extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
 813extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
 814
 815typedef int each_abbrev_fn(const unsigned char *sha1, void *);
 816extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
 817
 818/*
 819 * Try to read a SHA1 in hexadecimal format from the 40 characters
 820 * starting at hex.  Write the 20-byte result to sha1 in binary form.
 821 * Return 0 on success.  Reading stops if a NUL is encountered in the
 822 * input, so it is safe to pass this function an arbitrary
 823 * null-terminated string.
 824 */
 825extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 826
 827extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 828extern int read_ref_full(const char *refname, unsigned char *sha1,
 829                         int reading, int *flags);
 830extern int read_ref(const char *refname, unsigned char *sha1);
 831
 832/*
 833 * Resolve a reference, recursively following symbolic refererences.
 834 *
 835 * Store the referred-to object's name in sha1 and return the name of
 836 * the non-symbolic reference that ultimately pointed at it.  The
 837 * return value, if not NULL, is a pointer into either a static buffer
 838 * or the input ref.
 839 *
 840 * If the reference cannot be resolved to an object, the behavior
 841 * depends on the "reading" argument:
 842 *
 843 * - If reading is set, return NULL.
 844 *
 845 * - If reading is not set, clear sha1 and return the name of the last
 846 *   reference name in the chain, which will either be a non-symbolic
 847 *   reference or an undefined reference.  If this is a prelude to
 848 *   "writing" to the ref, the return value is the name of the ref
 849 *   that will actually be created or changed.
 850 *
 851 * If flag is non-NULL, set the value that it points to the
 852 * combination of REF_ISPACKED (if the reference was found among the
 853 * packed references) and REF_ISSYMREF (if the initial reference was a
 854 * symbolic reference).
 855 *
 856 * If ref is not a properly-formatted, normalized reference, return
 857 * NULL.  If more than MAXDEPTH recursive symbolic lookups are needed,
 858 * give up and return NULL.
 859 *
 860 * errno is sometimes set on errors, but not always.
 861 */
 862extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
 863extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
 864
 865extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 866extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 867extern int interpret_branch_name(const char *str, struct strbuf *);
 868extern int get_sha1_mb(const char *str, unsigned char *sha1);
 869
 870extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
 871extern const char *ref_rev_parse_rules[];
 872#define ref_fetch_rules ref_rev_parse_rules
 873
 874extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 875extern int validate_headref(const char *ref);
 876
 877extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 878extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 879extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 880extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
 881
 882extern void *read_object_with_reference(const unsigned char *sha1,
 883                                        const char *required_type,
 884                                        unsigned long *size,
 885                                        unsigned char *sha1_ret);
 886
 887extern struct object *peel_to_type(const char *name, int namelen,
 888                                   struct object *o, enum object_type);
 889
 890enum date_mode {
 891        DATE_NORMAL = 0,
 892        DATE_RELATIVE,
 893        DATE_SHORT,
 894        DATE_LOCAL,
 895        DATE_ISO8601,
 896        DATE_RFC2822,
 897        DATE_RAW
 898};
 899
 900const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 901void show_date_relative(unsigned long time, int tz, const struct timeval *now,
 902                        struct strbuf *timebuf);
 903int parse_date(const char *date, char *buf, int bufsize);
 904int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
 905void datestamp(char *buf, int bufsize);
 906#define approxidate(s) approxidate_careful((s), NULL)
 907unsigned long approxidate_careful(const char *, int *);
 908unsigned long approxidate_relative(const char *date, const struct timeval *now);
 909enum date_mode parse_date_format(const char *format);
 910
 911#define IDENT_STRICT           1
 912#define IDENT_NO_DATE          2
 913#define IDENT_NO_NAME          4
 914extern const char *git_author_info(int);
 915extern const char *git_committer_info(int);
 916extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 917extern const char *fmt_name(const char *name, const char *email);
 918extern const char *ident_default_email(void);
 919extern const char *git_editor(void);
 920extern const char *git_pager(int stdout_is_tty);
 921extern int git_ident_config(const char *, const char *, void *);
 922
 923struct ident_split {
 924        const char *name_begin;
 925        const char *name_end;
 926        const char *mail_begin;
 927        const char *mail_end;
 928        const char *date_begin;
 929        const char *date_end;
 930        const char *tz_begin;
 931        const char *tz_end;
 932};
 933/*
 934 * Signals an success with 0, but time part of the result may be NULL
 935 * if the input lacks timestamp and zone
 936 */
 937extern int split_ident_line(struct ident_split *, const char *, int);
 938
 939struct checkout {
 940        const char *base_dir;
 941        int base_dir_len;
 942        unsigned force:1,
 943                 quiet:1,
 944                 not_new:1,
 945                 refresh_cache:1;
 946};
 947
 948extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
 949
 950struct cache_def {
 951        char path[PATH_MAX + 1];
 952        int len;
 953        int flags;
 954        int track_flags;
 955        int prefix_len_stat_func;
 956};
 957
 958extern int has_symlink_leading_path(const char *name, int len);
 959extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
 960extern int check_leading_path(const char *name, int len);
 961extern int has_dirs_only_path(const char *name, int len, int prefix_len);
 962extern void schedule_dir_for_removal(const char *name, int len);
 963extern void remove_scheduled_dirs(void);
 964
 965extern struct alternate_object_database {
 966        struct alternate_object_database *next;
 967        char *name;
 968        char base[FLEX_ARRAY]; /* more */
 969} *alt_odb_list;
 970extern void prepare_alt_odb(void);
 971extern void read_info_alternates(const char * relative_base, int depth);
 972extern void add_to_alternates_file(const char *reference);
 973typedef int alt_odb_fn(struct alternate_object_database *, void *);
 974extern void foreach_alt_odb(alt_odb_fn, void*);
 975
 976struct pack_window {
 977        struct pack_window *next;
 978        unsigned char *base;
 979        off_t offset;
 980        size_t len;
 981        unsigned int last_used;
 982        unsigned int inuse_cnt;
 983};
 984
 985extern struct packed_git {
 986        struct packed_git *next;
 987        struct pack_window *windows;
 988        off_t pack_size;
 989        const void *index_data;
 990        size_t index_size;
 991        uint32_t num_objects;
 992        uint32_t num_bad_objects;
 993        unsigned char *bad_object_sha1;
 994        int index_version;
 995        time_t mtime;
 996        int pack_fd;
 997        unsigned pack_local:1,
 998                 pack_keep:1,
 999                 do_not_close:1;
1000        unsigned char sha1[20];
1001        /* something like ".git/objects/pack/xxxxx.pack" */
1002        char pack_name[FLEX_ARRAY]; /* more */
1003} *packed_git;
1004
1005struct pack_entry {
1006        off_t offset;
1007        unsigned char sha1[20];
1008        struct packed_git *p;
1009};
1010
1011struct ref {
1012        struct ref *next;
1013        unsigned char old_sha1[20];
1014        unsigned char new_sha1[20];
1015        char *symref;
1016        unsigned int
1017                force:1,
1018                forced_update:1,
1019                merge:1,
1020                deletion:1;
1021        enum {
1022                REF_STATUS_NONE = 0,
1023                REF_STATUS_OK,
1024                REF_STATUS_REJECT_NONFASTFORWARD,
1025                REF_STATUS_REJECT_ALREADY_EXISTS,
1026                REF_STATUS_REJECT_NODELETE,
1027                REF_STATUS_REJECT_FETCH_FIRST,
1028                REF_STATUS_REJECT_NEEDS_FORCE,
1029                REF_STATUS_UPTODATE,
1030                REF_STATUS_REMOTE_REJECT,
1031                REF_STATUS_EXPECTING_REPORT
1032        } status;
1033        char *remote_status;
1034        struct ref *peer_ref; /* when renaming */
1035        char name[FLEX_ARRAY]; /* more */
1036};
1037
1038#define REF_NORMAL      (1u << 0)
1039#define REF_HEADS       (1u << 1)
1040#define REF_TAGS        (1u << 2)
1041
1042extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1043
1044#define CONNECT_VERBOSE       (1u << 0)
1045extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1046extern int finish_connect(struct child_process *conn);
1047extern int git_connection_is_socket(struct child_process *conn);
1048struct extra_have_objects {
1049        int nr, alloc;
1050        unsigned char (*array)[20];
1051};
1052extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
1053extern int server_supports(const char *feature);
1054extern int parse_feature_request(const char *features, const char *feature);
1055extern const char *server_feature_value(const char *feature, int *len_ret);
1056extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1057
1058extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1059
1060extern void prepare_packed_git(void);
1061extern void reprepare_packed_git(void);
1062extern void install_packed_git(struct packed_git *pack);
1063
1064extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1065                                         struct packed_git *packs);
1066
1067extern void pack_report(void);
1068extern int open_pack_index(struct packed_git *);
1069extern void close_pack_index(struct packed_git *);
1070extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1071extern void close_pack_windows(struct packed_git *);
1072extern void unuse_pack(struct pack_window **);
1073extern void free_pack_by_name(const char *);
1074extern void clear_delta_base_cache(void);
1075extern struct packed_git *add_packed_git(const char *, int, int);
1076extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1077extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1078extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1079extern int is_pack_valid(struct packed_git *);
1080extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1081extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1082extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1083extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1084
1085struct object_info {
1086        /* Request */
1087        unsigned long *sizep;
1088
1089        /* Response */
1090        enum {
1091                OI_CACHED,
1092                OI_LOOSE,
1093                OI_PACKED,
1094                OI_DBCACHED
1095        } whence;
1096        union {
1097                /*
1098                 * struct {
1099                 *      ... Nothing to expose in this case
1100                 * } cached;
1101                 * struct {
1102                 *      ... Nothing to expose in this case
1103                 * } loose;
1104                 */
1105                struct {
1106                        struct packed_git *pack;
1107                        off_t offset;
1108                        unsigned int is_delta;
1109                } packed;
1110        } u;
1111};
1112extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1113
1114/* Dumb servers support */
1115extern int update_server_info(int);
1116
1117/* git_config_parse_key() returns these negated: */
1118#define CONFIG_INVALID_KEY 1
1119#define CONFIG_NO_SECTION_OR_NAME 2
1120/* git_config_set(), git_config_set_multivar() return the above or these: */
1121#define CONFIG_NO_LOCK -1
1122#define CONFIG_INVALID_FILE 3
1123#define CONFIG_NO_WRITE 4
1124#define CONFIG_NOTHING_SET 5
1125#define CONFIG_INVALID_PATTERN 6
1126#define CONFIG_GENERIC_ERROR 7
1127
1128typedef int (*config_fn_t)(const char *, const char *, void *);
1129extern int git_default_config(const char *, const char *, void *);
1130extern int git_config_from_file(config_fn_t fn, const char *, void *);
1131extern void git_config_push_parameter(const char *text);
1132extern int git_config_from_parameters(config_fn_t fn, void *data);
1133extern int git_config(config_fn_t fn, void *);
1134extern int git_config_with_options(config_fn_t fn, void *,
1135                                   const char *filename, int respect_includes);
1136extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1137extern int git_parse_ulong(const char *, unsigned long *);
1138extern int git_config_int(const char *, const char *);
1139extern unsigned long git_config_ulong(const char *, const char *);
1140extern int git_config_bool_or_int(const char *, const char *, int *);
1141extern int git_config_bool(const char *, const char *);
1142extern int git_config_maybe_bool(const char *, const char *);
1143extern int git_config_string(const char **, const char *, const char *);
1144extern int git_config_pathname(const char **, const char *, const char *);
1145extern int git_config_set_in_file(const char *, const char *, const char *);
1146extern int git_config_set(const char *, const char *);
1147extern int git_config_parse_key(const char *, char **, int *);
1148extern int git_config_set_multivar(const char *, const char *, const char *, int);
1149extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1150extern int git_config_rename_section(const char *, const char *);
1151extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1152extern const char *git_etc_gitconfig(void);
1153extern int check_repository_format_version(const char *var, const char *value, void *cb);
1154extern int git_env_bool(const char *, int);
1155extern int git_config_system(void);
1156extern int config_error_nonbool(const char *);
1157#if defined(__GNUC__) && ! defined(__clang__)
1158#define config_error_nonbool(s) (config_error_nonbool(s), -1)
1159#endif
1160extern const char *get_log_output_encoding(void);
1161extern const char *get_commit_output_encoding(void);
1162
1163extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1164
1165struct config_include_data {
1166        int depth;
1167        config_fn_t fn;
1168        void *data;
1169};
1170#define CONFIG_INCLUDE_INIT { 0 }
1171extern int git_config_include(const char *name, const char *value, void *data);
1172
1173/*
1174 * Match and parse a config key of the form:
1175 *
1176 *   section.(subsection.)?key
1177 *
1178 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1179 * we return -1 if it does not match, 0 otherwise. The subsection and key
1180 * out-parameters are filled by the function (and subsection is NULL if it is
1181 * missing).
1182 */
1183extern int parse_config_key(const char *var,
1184                            const char *section,
1185                            const char **subsection, int *subsection_len,
1186                            const char **key);
1187
1188extern int committer_ident_sufficiently_given(void);
1189extern int author_ident_sufficiently_given(void);
1190
1191extern const char *git_commit_encoding;
1192extern const char *git_log_output_encoding;
1193extern const char *git_mailmap_file;
1194extern const char *git_mailmap_blob;
1195
1196/* IO helper functions */
1197extern void maybe_flush_or_die(FILE *, const char *);
1198extern int copy_fd(int ifd, int ofd);
1199extern int copy_file(const char *dst, const char *src, int mode);
1200extern int copy_file_with_time(const char *dst, const char *src, int mode);
1201extern void write_or_die(int fd, const void *buf, size_t count);
1202extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1203extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1204extern void fsync_or_die(int fd, const char *);
1205
1206extern ssize_t read_in_full(int fd, void *buf, size_t count);
1207extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1208static inline ssize_t write_str_in_full(int fd, const char *str)
1209{
1210        return write_in_full(fd, str, strlen(str));
1211}
1212
1213/* pager.c */
1214extern void setup_pager(void);
1215extern const char *pager_program;
1216extern int pager_in_use(void);
1217extern int pager_use_color;
1218extern int term_columns(void);
1219extern int decimal_width(int);
1220extern int check_pager_config(const char *cmd);
1221
1222extern const char *editor_program;
1223extern const char *askpass_program;
1224extern const char *excludes_file;
1225
1226/* base85 */
1227int decode_85(char *dst, const char *line, int linelen);
1228void encode_85(char *buf, const unsigned char *data, int bytes);
1229
1230/* alloc.c */
1231extern void *alloc_blob_node(void);
1232extern void *alloc_tree_node(void);
1233extern void *alloc_commit_node(void);
1234extern void *alloc_tag_node(void);
1235extern void *alloc_object_node(void);
1236extern void alloc_report(void);
1237
1238/* trace.c */
1239__attribute__((format (printf, 1, 2)))
1240extern void trace_printf(const char *format, ...);
1241__attribute__((format (printf, 2, 3)))
1242extern void trace_argv_printf(const char **argv, const char *format, ...);
1243extern void trace_repo_setup(const char *prefix);
1244extern int trace_want(const char *key);
1245extern void trace_strbuf(const char *key, const struct strbuf *buf);
1246
1247void packet_trace_identity(const char *prog);
1248
1249/* add */
1250/*
1251 * return 0 if success, 1 - if addition of a file failed and
1252 * ADD_FILES_IGNORE_ERRORS was specified in flags
1253 */
1254int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1255
1256/* diff.c */
1257extern int diff_auto_refresh_index;
1258
1259/* match-trees.c */
1260void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1261void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1262
1263/*
1264 * whitespace rules.
1265 * used by both diff and apply
1266 * last two digits are tab width
1267 */
1268#define WS_BLANK_AT_EOL         0100
1269#define WS_SPACE_BEFORE_TAB     0200
1270#define WS_INDENT_WITH_NON_TAB  0400
1271#define WS_CR_AT_EOL           01000
1272#define WS_BLANK_AT_EOF        02000
1273#define WS_TAB_IN_INDENT       04000
1274#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1275#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1276#define WS_TAB_WIDTH_MASK        077
1277extern unsigned whitespace_rule_cfg;
1278extern unsigned whitespace_rule(const char *);
1279extern unsigned parse_whitespace_rule(const char *);
1280extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1281extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1282extern char *whitespace_error_string(unsigned ws);
1283extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1284extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1285#define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1286
1287/* ls-files */
1288int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1289void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1290
1291char *alias_lookup(const char *alias);
1292int split_cmdline(char *cmdline, const char ***argv);
1293/* Takes a negative value returned by split_cmdline */
1294const char *split_cmdline_strerror(int cmdline_errno);
1295
1296/* git.c */
1297struct startup_info {
1298        int have_repository;
1299        const char *prefix;
1300};
1301extern struct startup_info *startup_info;
1302
1303/* merge.c */
1304struct commit_list;
1305int try_merge_command(const char *strategy, size_t xopts_nr,
1306                const char **xopts, struct commit_list *common,
1307                const char *head_arg, struct commit_list *remotes);
1308int checkout_fast_forward(const unsigned char *from,
1309                          const unsigned char *to,
1310                          int overwrite_ignore);
1311
1312
1313int sane_execvp(const char *file, char *const argv[]);
1314
1315#endif /* CACHE_H */