THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1912 lines
65KB

  1. #ifndef CACHE_H
  2. #define CACHE_H
  3. #include "git-compat-util.h"
  4. #include "strbuf.h"
  5. #include "hashmap.h"
  6. #include "list.h"
  7. #include "advice.h"
  8. #include "gettext.h"
  9. #include "convert.h"
  10. #include "trace.h"
  11. #include "trace2.h"
  12. #include "string-list.h"
  13. #include "pack-revindex.h"
  14. #include "hash.h"
  15. #include "path.h"
  16. #include "sha1-array.h"
  17. #include "repository.h"
  18. #include "mem-pool.h"
  19. #include <zlib.h>
  20. typedef 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. void git_inflate_init(git_zstream *);
  30. void git_inflate_init_gzip_only(git_zstream *);
  31. void git_inflate_end(git_zstream *);
  32. int git_inflate(git_zstream *, int flush);
  33. void git_deflate_init(git_zstream *, int level);
  34. void git_deflate_init_gzip(git_zstream *, int level);
  35. void git_deflate_init_raw(git_zstream *, int level);
  36. void git_deflate_end(git_zstream *);
  37. int git_deflate_abort(git_zstream *);
  38. int git_deflate_end_gently(git_zstream *);
  39. int git_deflate(git_zstream *, int flush);
  40. unsigned long git_deflate_bound(git_zstream *, unsigned long);
  41. #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  42. #define DTYPE(de) ((de)->d_type)
  43. #else
  44. #undef DT_UNKNOWN
  45. #undef DT_DIR
  46. #undef DT_REG
  47. #undef DT_LNK
  48. #define DT_UNKNOWN 0
  49. #define DT_DIR 1
  50. #define DT_REG 2
  51. #define DT_LNK 3
  52. #define DTYPE(de) DT_UNKNOWN
  53. #endif
  54. /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
  55. #define S_IFINVALID 0030000
  56. /*
  57. * A "directory link" is a link to another git directory.
  58. *
  59. * The value 0160000 is not normally a valid mode, and
  60. * also just happens to be S_IFDIR + S_IFLNK
  61. */
  62. #define S_IFGITLINK 0160000
  63. #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
  64. /*
  65. * Some mode bits are also used internally for computations.
  66. *
  67. * They *must* not overlap with any valid modes, and they *must* not be emitted
  68. * to outside world - i.e. appear on disk or network. In other words, it's just
  69. * temporary fields, which we internally use, but they have to stay in-house.
  70. *
  71. * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
  72. * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
  73. */
  74. /* used internally in tree-diff */
  75. #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
  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. * Basic data structures for the directory cache
  98. */
  99. #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
  100. struct cache_header {
  101. uint32_t hdr_signature;
  102. uint32_t hdr_version;
  103. uint32_t hdr_entries;
  104. };
  105. #define INDEX_FORMAT_LB 2
  106. #define INDEX_FORMAT_UB 4
  107. /*
  108. * The "cache_time" is just the low 32 bits of the
  109. * time. It doesn't matter if it overflows - we only
  110. * check it for equality in the 32 bits we save.
  111. */
  112. struct cache_time {
  113. uint32_t sec;
  114. uint32_t nsec;
  115. };
  116. struct stat_data {
  117. struct cache_time sd_ctime;
  118. struct cache_time sd_mtime;
  119. unsigned int sd_dev;
  120. unsigned int sd_ino;
  121. unsigned int sd_uid;
  122. unsigned int sd_gid;
  123. unsigned int sd_size;
  124. };
  125. struct cache_entry {
  126. struct hashmap_entry ent;
  127. struct stat_data ce_stat_data;
  128. unsigned int ce_mode;
  129. unsigned int ce_flags;
  130. unsigned int mem_pool_allocated;
  131. unsigned int ce_namelen;
  132. unsigned int index; /* for link extension */
  133. struct object_id oid;
  134. char name[FLEX_ARRAY]; /* more */
  135. };
  136. #define CE_STAGEMASK (0x3000)
  137. #define CE_EXTENDED (0x4000)
  138. #define CE_VALID (0x8000)
  139. #define CE_STAGESHIFT 12
  140. /*
  141. * Range 0xFFFF0FFF in ce_flags is divided into
  142. * two parts: in-memory flags and on-disk ones.
  143. * Flags in CE_EXTENDED_FLAGS will get saved on-disk
  144. * if you want to save a new flag, add it in
  145. * CE_EXTENDED_FLAGS
  146. *
  147. * In-memory only flags
  148. */
  149. #define CE_UPDATE (1 << 16)
  150. #define CE_REMOVE (1 << 17)
  151. #define CE_UPTODATE (1 << 18)
  152. #define CE_ADDED (1 << 19)
  153. #define CE_HASHED (1 << 20)
  154. #define CE_FSMONITOR_VALID (1 << 21)
  155. #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
  156. #define CE_CONFLICTED (1 << 23)
  157. #define CE_UNPACKED (1 << 24)
  158. #define CE_NEW_SKIP_WORKTREE (1 << 25)
  159. /* used to temporarily mark paths matched by pathspecs */
  160. #define CE_MATCHED (1 << 26)
  161. #define CE_UPDATE_IN_BASE (1 << 27)
  162. #define CE_STRIP_NAME (1 << 28)
  163. /*
  164. * Extended on-disk flags
  165. */
  166. #define CE_INTENT_TO_ADD (1 << 29)
  167. #define CE_SKIP_WORKTREE (1 << 30)
  168. /* CE_EXTENDED2 is for future extension */
  169. #define CE_EXTENDED2 (1U << 31)
  170. #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
  171. /*
  172. * Safeguard to avoid saving wrong flags:
  173. * - CE_EXTENDED2 won't get saved until its semantic is known
  174. * - Bits in 0x0000FFFF have been saved in ce_flags already
  175. * - Bits in 0x003F0000 are currently in-memory flags
  176. */
  177. #if CE_EXTENDED_FLAGS & 0x803FFFFF
  178. #error "CE_EXTENDED_FLAGS out of range"
  179. #endif
  180. /* Forward structure decls */
  181. struct pathspec;
  182. struct child_process;
  183. struct tree;
  184. /*
  185. * Copy the sha1 and stat state of a cache entry from one to
  186. * another. But we never change the name, or the hash state!
  187. */
  188. static inline void copy_cache_entry(struct cache_entry *dst,
  189. const struct cache_entry *src)
  190. {
  191. unsigned int state = dst->ce_flags & CE_HASHED;
  192. int mem_pool_allocated = dst->mem_pool_allocated;
  193. /* Don't copy hash chain and name */
  194. memcpy(&dst->ce_stat_data, &src->ce_stat_data,
  195. offsetof(struct cache_entry, name) -
  196. offsetof(struct cache_entry, ce_stat_data));
  197. /* Restore the hash state */
  198. dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
  199. /* Restore the mem_pool_allocated flag */
  200. dst->mem_pool_allocated = mem_pool_allocated;
  201. }
  202. static inline unsigned create_ce_flags(unsigned stage)
  203. {
  204. return (stage << CE_STAGESHIFT);
  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. #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
  213. #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
  214. static 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. }
  222. static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
  223. unsigned int mode)
  224. {
  225. extern int trust_executable_bit, has_symlinks;
  226. if (!has_symlinks && S_ISREG(mode) &&
  227. ce && S_ISLNK(ce->ce_mode))
  228. return ce->ce_mode;
  229. if (!trust_executable_bit && S_ISREG(mode)) {
  230. if (ce && S_ISREG(ce->ce_mode))
  231. return ce->ce_mode;
  232. return create_ce_mode(0666);
  233. }
  234. return create_ce_mode(mode);
  235. }
  236. static inline int ce_to_dtype(const struct cache_entry *ce)
  237. {
  238. unsigned ce_mode = ntohl(ce->ce_mode);
  239. if (S_ISREG(ce_mode))
  240. return DT_REG;
  241. else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
  242. return DT_DIR;
  243. else if (S_ISLNK(ce_mode))
  244. return DT_LNK;
  245. else
  246. return DT_UNKNOWN;
  247. }
  248. static inline unsigned int canon_mode(unsigned int mode)
  249. {
  250. if (S_ISREG(mode))
  251. return S_IFREG | ce_permissions(mode);
  252. if (S_ISLNK(mode))
  253. return S_IFLNK;
  254. if (S_ISDIR(mode))
  255. return S_IFDIR;
  256. return S_IFGITLINK;
  257. }
  258. #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
  259. #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
  260. #define CE_ENTRY_CHANGED (1 << 1)
  261. #define CE_ENTRY_REMOVED (1 << 2)
  262. #define CE_ENTRY_ADDED (1 << 3)
  263. #define RESOLVE_UNDO_CHANGED (1 << 4)
  264. #define CACHE_TREE_CHANGED (1 << 5)
  265. #define SPLIT_INDEX_ORDERED (1 << 6)
  266. #define UNTRACKED_CHANGED (1 << 7)
  267. #define FSMONITOR_CHANGED (1 << 8)
  268. struct split_index;
  269. struct untracked_cache;
  270. struct index_state {
  271. struct cache_entry **cache;
  272. unsigned int version;
  273. unsigned int cache_nr, cache_alloc, cache_changed;
  274. struct string_list *resolve_undo;
  275. struct cache_tree *cache_tree;
  276. struct split_index *split_index;
  277. struct cache_time timestamp;
  278. unsigned name_hash_initialized : 1,
  279. initialized : 1,
  280. drop_cache_tree : 1,
  281. updated_workdir : 1,
  282. updated_skipworktree : 1,
  283. fsmonitor_has_run_once : 1;
  284. struct hashmap name_hash;
  285. struct hashmap dir_hash;
  286. struct object_id oid;
  287. struct untracked_cache *untracked;
  288. uint64_t fsmonitor_last_update;
  289. struct ewah_bitmap *fsmonitor_dirty;
  290. struct mem_pool *ce_mem_pool;
  291. };
  292. /* Name hashing */
  293. int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
  294. void add_name_hash(struct index_state *istate, struct cache_entry *ce);
  295. void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
  296. void free_name_hash(struct index_state *istate);
  297. /* Cache entry creation and cleanup */
  298. /*
  299. * Create cache_entry intended for use in the specified index. Caller
  300. * is responsible for discarding the cache_entry with
  301. * `discard_cache_entry`.
  302. */
  303. struct cache_entry *make_cache_entry(struct index_state *istate,
  304. unsigned int mode,
  305. const struct object_id *oid,
  306. const char *path,
  307. int stage,
  308. unsigned int refresh_options);
  309. struct cache_entry *make_empty_cache_entry(struct index_state *istate,
  310. size_t name_len);
  311. /*
  312. * Create a cache_entry that is not intended to be added to an index.
  313. * Caller is responsible for discarding the cache_entry
  314. * with `discard_cache_entry`.
  315. */
  316. struct cache_entry *make_transient_cache_entry(unsigned int mode,
  317. const struct object_id *oid,
  318. const char *path,
  319. int stage);
  320. struct cache_entry *make_empty_transient_cache_entry(size_t name_len);
  321. /*
  322. * Discard cache entry.
  323. */
  324. void discard_cache_entry(struct cache_entry *ce);
  325. /*
  326. * Check configuration if we should perform extra validation on cache
  327. * entries.
  328. */
  329. int should_validate_cache_entries(void);
  330. /*
  331. * Duplicate a cache_entry. Allocate memory for the new entry from a
  332. * memory_pool. Takes into account cache_entry fields that are meant
  333. * for managing the underlying memory allocation of the cache_entry.
  334. */
  335. struct cache_entry *dup_cache_entry(const struct cache_entry *ce, struct index_state *istate);
  336. /*
  337. * Validate the cache entries in the index. This is an internal
  338. * consistency check that the cache_entry structs are allocated from
  339. * the expected memory pool.
  340. */
  341. void validate_cache_entries(const struct index_state *istate);
  342. #ifdef USE_THE_INDEX_COMPATIBILITY_MACROS
  343. extern struct index_state the_index;
  344. #define active_cache (the_index.cache)
  345. #define active_nr (the_index.cache_nr)
  346. #define active_alloc (the_index.cache_alloc)
  347. #define active_cache_changed (the_index.cache_changed)
  348. #define active_cache_tree (the_index.cache_tree)
  349. #define read_cache() repo_read_index(the_repository)
  350. #define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
  351. #define read_cache_preload(pathspec) repo_read_index_preload(the_repository, (pathspec), 0)
  352. #define is_cache_unborn() is_index_unborn(&the_index)
  353. #define read_cache_unmerged() repo_read_index_unmerged(the_repository)
  354. #define discard_cache() discard_index(&the_index)
  355. #define unmerged_cache() unmerged_index(&the_index)
  356. #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
  357. #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
  358. #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
  359. #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
  360. #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
  361. #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
  362. #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
  363. #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
  364. #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
  365. #define refresh_and_write_cache(refresh_flags, write_flags, gentle) repo_refresh_and_write_index(the_repository, (refresh_flags), (write_flags), (gentle), NULL, NULL, NULL)
  366. #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
  367. #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
  368. #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
  369. #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
  370. #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
  371. #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
  372. #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
  373. #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
  374. #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
  375. #define hold_locked_index(lock_file, flags) repo_hold_locked_index(the_repository, (lock_file), (flags))
  376. #endif
  377. #define TYPE_BITS 3
  378. /*
  379. * Values in this enum (except those outside the 3 bit range) are part
  380. * of pack file format. See Documentation/technical/pack-format.txt
  381. * for more information.
  382. */
  383. enum object_type {
  384. OBJ_BAD = -1,
  385. OBJ_NONE = 0,
  386. OBJ_COMMIT = 1,
  387. OBJ_TREE = 2,
  388. OBJ_BLOB = 3,
  389. OBJ_TAG = 4,
  390. /* 5 for future expansion */
  391. OBJ_OFS_DELTA = 6,
  392. OBJ_REF_DELTA = 7,
  393. OBJ_ANY,
  394. OBJ_MAX
  395. };
  396. static inline enum object_type object_type(unsigned int mode)
  397. {
  398. return S_ISDIR(mode) ? OBJ_TREE :
  399. S_ISGITLINK(mode) ? OBJ_COMMIT :
  400. OBJ_BLOB;
  401. }
  402. /* Double-check local_repo_env below if you add to this list. */
  403. #define GIT_DIR_ENVIRONMENT "GIT_DIR"
  404. #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
  405. #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
  406. #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
  407. #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
  408. #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
  409. #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
  410. #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
  411. #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
  412. #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
  413. #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
  414. #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
  415. #define CONFIG_ENVIRONMENT "GIT_CONFIG"
  416. #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
  417. #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
  418. #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
  419. #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
  420. #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
  421. #define GITATTRIBUTES_FILE ".gitattributes"
  422. #define INFOATTRIBUTES_FILE "info/attributes"
  423. #define ATTRIBUTE_MACRO_PREFIX "[attr]"
  424. #define GITMODULES_FILE ".gitmodules"
  425. #define GITMODULES_INDEX ":.gitmodules"
  426. #define GITMODULES_HEAD "HEAD:.gitmodules"
  427. #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
  428. #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
  429. #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
  430. #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
  431. #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
  432. #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
  433. #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
  434. #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
  435. #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
  436. #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
  437. #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
  438. #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
  439. /*
  440. * Environment variable used in handshaking the wire protocol.
  441. * Contains a colon ':' separated list of keys with optional values
  442. * 'key[=value]'. Presence of unknown keys and values must be
  443. * ignored.
  444. */
  445. #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
  446. /* HTTP header used to handshake the wire protocol */
  447. #define GIT_PROTOCOL_HEADER "Git-Protocol"
  448. /*
  449. * This environment variable is expected to contain a boolean indicating
  450. * whether we should or should not treat:
  451. *
  452. * GIT_DIR=foo.git git ...
  453. *
  454. * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
  455. * of this, but we use it internally to communicate to sub-processes that we
  456. * are in a bare repo. If not set, defaults to true.
  457. */
  458. #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
  459. /*
  460. * Repository-local GIT_* environment variables; these will be cleared
  461. * when git spawns a sub-process that runs inside another repository.
  462. * The array is NULL-terminated, which makes it easy to pass in the "env"
  463. * parameter of a run-command invocation, or to do a simple walk.
  464. */
  465. extern const char * const local_repo_env[];
  466. void setup_git_env(const char *git_dir);
  467. /*
  468. * Returns true iff we have a configured git repository (either via
  469. * setup_git_directory, or in the environment via $GIT_DIR).
  470. */
  471. int have_git_dir(void);
  472. extern int is_bare_repository_cfg;
  473. int is_bare_repository(void);
  474. int is_inside_git_dir(void);
  475. extern char *git_work_tree_cfg;
  476. int is_inside_work_tree(void);
  477. const char *get_git_dir(void);
  478. const char *get_git_common_dir(void);
  479. char *get_object_directory(void);
  480. char *get_index_file(void);
  481. char *get_graft_file(struct repository *r);
  482. void set_git_dir(const char *path);
  483. int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
  484. int get_common_dir(struct strbuf *sb, const char *gitdir);
  485. const char *get_git_namespace(void);
  486. const char *strip_namespace(const char *namespaced_ref);
  487. const char *get_super_prefix(void);
  488. const char *get_git_work_tree(void);
  489. /*
  490. * Return true if the given path is a git directory; note that this _just_
  491. * looks at the directory itself. If you want to know whether "foo/.git"
  492. * is a repository, you must feed that path, not just "foo".
  493. */
  494. int is_git_directory(const char *path);
  495. /*
  496. * Return 1 if the given path is the root of a git repository or
  497. * submodule, else 0. Will not return 1 for bare repositories with the
  498. * exception of creating a bare repository in "foo/.git" and calling
  499. * is_git_repository("foo").
  500. *
  501. * If we run into read errors, we err on the side of saying "yes, it is",
  502. * as we usually consider sub-repos precious, and would prefer to err on the
  503. * side of not disrupting or deleting them.
  504. */
  505. int is_nonbare_repository_dir(struct strbuf *path);
  506. #define READ_GITFILE_ERR_STAT_FAILED 1
  507. #define READ_GITFILE_ERR_NOT_A_FILE 2
  508. #define READ_GITFILE_ERR_OPEN_FAILED 3
  509. #define READ_GITFILE_ERR_READ_FAILED 4
  510. #define READ_GITFILE_ERR_INVALID_FORMAT 5
  511. #define READ_GITFILE_ERR_NO_PATH 6
  512. #define READ_GITFILE_ERR_NOT_A_REPO 7
  513. #define READ_GITFILE_ERR_TOO_LARGE 8
  514. void read_gitfile_error_die(int error_code, const char *path, const char *dir);
  515. const char *read_gitfile_gently(const char *path, int *return_error_code);
  516. #define read_gitfile(path) read_gitfile_gently((path), NULL)
  517. const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
  518. #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
  519. void set_git_work_tree(const char *tree);
  520. #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
  521. void setup_work_tree(void);
  522. /*
  523. * Find the commondir and gitdir of the repository that contains the current
  524. * working directory, without changing the working directory or other global
  525. * state. The result is appended to commondir and gitdir. If the discovered
  526. * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
  527. * both have the same result appended to the buffer. The return value is
  528. * either 0 upon success and non-zero if no repository was found.
  529. */
  530. int discover_git_directory(struct strbuf *commondir,
  531. struct strbuf *gitdir);
  532. const char *setup_git_directory_gently(int *);
  533. const char *setup_git_directory(void);
  534. char *prefix_path(const char *prefix, int len, const char *path);
  535. char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
  536. /*
  537. * Concatenate "prefix" (if len is non-zero) and "path", with no
  538. * connecting characters (so "prefix" should end with a "/").
  539. * Unlike prefix_path, this should be used if the named file does
  540. * not have to interact with index entry; i.e. name of a random file
  541. * on the filesystem.
  542. *
  543. * The return value is always a newly allocated string (even if the
  544. * prefix was empty).
  545. */
  546. char *prefix_filename(const char *prefix, const char *path);
  547. int check_filename(const char *prefix, const char *name);
  548. void verify_filename(const char *prefix,
  549. const char *name,
  550. int diagnose_misspelt_rev);
  551. void verify_non_filename(const char *prefix, const char *name);
  552. int path_inside_repo(const char *prefix, const char *path);
  553. #define INIT_DB_QUIET 0x0001
  554. #define INIT_DB_EXIST_OK 0x0002
  555. int init_db(const char *git_dir, const char *real_git_dir,
  556. const char *template_dir, unsigned int flags);
  557. void sanitize_stdfds(void);
  558. int daemonize(void);
  559. #define alloc_nr(x) (((x)+16)*3/2)
  560. /*
  561. * Realloc the buffer pointed at by variable 'x' so that it can hold
  562. * at least 'nr' entries; the number of entries currently allocated
  563. * is 'alloc', using the standard growing factor alloc_nr() macro.
  564. *
  565. * Consider using ALLOC_GROW_BY instead of ALLOC_GROW as it has some
  566. * added niceties.
  567. *
  568. * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
  569. */
  570. #define ALLOC_GROW(x, nr, alloc) \
  571. do { \
  572. if ((nr) > alloc) { \
  573. if (alloc_nr(alloc) < (nr)) \
  574. alloc = (nr); \
  575. else \
  576. alloc = alloc_nr(alloc); \
  577. REALLOC_ARRAY(x, alloc); \
  578. } \
  579. } while (0)
  580. /*
  581. * Similar to ALLOC_GROW but handles updating of the nr value and
  582. * zeroing the bytes of the newly-grown array elements.
  583. *
  584. * DO NOT USE any expression with side-effect for any of the
  585. * arguments.
  586. */
  587. #define ALLOC_GROW_BY(x, nr, increase, alloc) \
  588. do { \
  589. if (increase) { \
  590. size_t new_nr = nr + (increase); \
  591. if (new_nr < nr) \
  592. BUG("negative growth in ALLOC_GROW_BY"); \
  593. ALLOC_GROW(x, new_nr, alloc); \
  594. memset((x) + nr, 0, sizeof(*(x)) * (increase)); \
  595. nr = new_nr; \
  596. } \
  597. } while (0)
  598. /* Initialize and use the cache information */
  599. struct lock_file;
  600. void preload_index(struct index_state *index,
  601. const struct pathspec *pathspec,
  602. unsigned int refresh_flags);
  603. int do_read_index(struct index_state *istate, const char *path,
  604. int must_exist); /* for testting only! */
  605. int read_index_from(struct index_state *, const char *path,
  606. const char *gitdir);
  607. int is_index_unborn(struct index_state *);
  608. /* For use with `write_locked_index()`. */
  609. #define COMMIT_LOCK (1 << 0)
  610. #define SKIP_IF_UNCHANGED (1 << 1)
  611. /*
  612. * Write the index while holding an already-taken lock. Close the lock,
  613. * and if `COMMIT_LOCK` is given, commit it.
  614. *
  615. * Unless a split index is in use, write the index into the lockfile.
  616. *
  617. * With a split index, write the shared index to a temporary file,
  618. * adjust its permissions and rename it into place, then write the
  619. * split index to the lockfile. If the temporary file for the shared
  620. * index cannot be created, fall back to the behavior described in
  621. * the previous paragraph.
  622. *
  623. * With `COMMIT_LOCK`, the lock is always committed or rolled back.
  624. * Without it, the lock is closed, but neither committed nor rolled
  625. * back.
  626. *
  627. * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
  628. * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
  629. */
  630. int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
  631. int discard_index(struct index_state *);
  632. void move_index_extensions(struct index_state *dst, struct index_state *src);
  633. int unmerged_index(const struct index_state *);
  634. /**
  635. * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
  636. * compares istate to HEAD. If tree is NULL and on an unborn branch,
  637. * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
  638. * provided, the space-separated list of files that differ will be appended
  639. * to it.
  640. */
  641. int repo_index_has_changes(struct repository *repo,
  642. struct tree *tree,
  643. struct strbuf *sb);
  644. int verify_path(const char *path, unsigned mode);
  645. int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
  646. int index_dir_exists(struct index_state *istate, const char *name, int namelen);
  647. void adjust_dirname_case(struct index_state *istate, char *name);
  648. struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
  649. /*
  650. * Searches for an entry defined by name and namelen in the given index.
  651. * If the return value is positive (including 0) it is the position of an
  652. * exact match. If the return value is negative, the negated value minus 1
  653. * is the position where the entry would be inserted.
  654. * Example: The current index consists of these files and its stages:
  655. *
  656. * b#0, d#0, f#1, f#3
  657. *
  658. * index_name_pos(&index, "a", 1) -> -1
  659. * index_name_pos(&index, "b", 1) -> 0
  660. * index_name_pos(&index, "c", 1) -> -2
  661. * index_name_pos(&index, "d", 1) -> 1
  662. * index_name_pos(&index, "e", 1) -> -3
  663. * index_name_pos(&index, "f", 1) -> -3
  664. * index_name_pos(&index, "g", 1) -> -5
  665. */
  666. int index_name_pos(const struct index_state *, const char *name, int namelen);
  667. /*
  668. * Some functions return the negative complement of an insert position when a
  669. * precise match was not found but a position was found where the entry would
  670. * need to be inserted. This helper protects that logic from any integer
  671. * underflow.
  672. */
  673. static inline int index_pos_to_insert_pos(uintmax_t pos)
  674. {
  675. if (pos > INT_MAX)
  676. die("overflow: -1 - %"PRIuMAX, pos);
  677. return -1 - (int)pos;
  678. }
  679. #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
  680. #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
  681. #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
  682. #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
  683. #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
  684. #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
  685. #define ADD_CACHE_RENORMALIZE 64 /* Pass along HASH_RENORMALIZE */
  686. int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
  687. void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
  688. /* Remove entry, return true if there are more entries to go. */
  689. int remove_index_entry_at(struct index_state *, int pos);
  690. void remove_marked_cache_entries(struct index_state *istate, int invalidate);
  691. int remove_file_from_index(struct index_state *, const char *path);
  692. #define ADD_CACHE_VERBOSE 1
  693. #define ADD_CACHE_PRETEND 2
  694. #define ADD_CACHE_IGNORE_ERRORS 4
  695. #define ADD_CACHE_IGNORE_REMOVAL 8
  696. #define ADD_CACHE_INTENT 16
  697. /*
  698. * These two are used to add the contents of the file at path
  699. * to the index, marking the working tree up-to-date by storing
  700. * the cached stat info in the resulting cache entry. A caller
  701. * that has already run lstat(2) on the path can call
  702. * add_to_index(), and all others can call add_file_to_index();
  703. * the latter will do necessary lstat(2) internally before
  704. * calling the former.
  705. */
  706. int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
  707. int add_file_to_index(struct index_state *, const char *path, int flags);
  708. int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
  709. int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
  710. void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
  711. int index_name_is_other(const struct index_state *, const char *, int);
  712. void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
  713. /* do stat comparison even if CE_VALID is true */
  714. #define CE_MATCH_IGNORE_VALID 01
  715. /* do not check the contents but report dirty on racily-clean entries */
  716. #define CE_MATCH_RACY_IS_DIRTY 02
  717. /* do stat comparison even if CE_SKIP_WORKTREE is true */
  718. #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
  719. /* ignore non-existent files during stat update */
  720. #define CE_MATCH_IGNORE_MISSING 0x08
  721. /* enable stat refresh */
  722. #define CE_MATCH_REFRESH 0x10
  723. /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
  724. #define CE_MATCH_IGNORE_FSMONITOR 0X20
  725. int is_racy_timestamp(const struct index_state *istate,
  726. const struct cache_entry *ce);
  727. int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
  728. int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
  729. #define HASH_WRITE_OBJECT 1
  730. #define HASH_FORMAT_CHECK 2
  731. #define HASH_RENORMALIZE 4
  732. int index_fd(struct index_state *istate, struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
  733. int index_path(struct index_state *istate, struct object_id *oid, const char *path, struct stat *st, unsigned flags);
  734. /*
  735. * Record to sd the data from st that we use to check whether a file
  736. * might have changed.
  737. */
  738. void fill_stat_data(struct stat_data *sd, struct stat *st);
  739. /*
  740. * Return 0 if st is consistent with a file not having been changed
  741. * since sd was filled. If there are differences, return a
  742. * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
  743. * INODE_CHANGED, and DATA_CHANGED.
  744. */
  745. int match_stat_data(const struct stat_data *sd, struct stat *st);
  746. int match_stat_data_racy(const struct index_state *istate,
  747. const struct stat_data *sd, struct stat *st);
  748. void fill_stat_cache_info(struct index_state *istate, struct cache_entry *ce, struct stat *st);
  749. #define REFRESH_REALLY 0x0001 /* ignore_valid */
  750. #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
  751. #define REFRESH_QUIET 0x0004 /* be quiet about it */
  752. #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
  753. #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
  754. #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
  755. #define REFRESH_PROGRESS 0x0040 /* show progress bar if stderr is tty */
  756. int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
  757. /*
  758. * Refresh the index and write it to disk.
  759. *
  760. * 'refresh_flags' is passed directly to 'refresh_index()', while
  761. * 'COMMIT_LOCK | write_flags' is passed to 'write_locked_index()', so
  762. * the lockfile is always either committed or rolled back.
  763. *
  764. * If 'gentle' is passed, errors locking the index are ignored.
  765. *
  766. * Return 1 if refreshing the index returns an error, -1 if writing
  767. * the index to disk fails, 0 on success.
  768. *
  769. * Note that if refreshing the index returns an error, we still write
  770. * out the index (unless locking fails).
  771. */
  772. int repo_refresh_and_write_index(struct repository*, unsigned int refresh_flags, unsigned int write_flags, int gentle, const struct pathspec *, char *seen, const char *header_msg);
  773. struct cache_entry *refresh_cache_entry(struct index_state *, struct cache_entry *, unsigned int);
  774. void set_alternate_index_output(const char *);
  775. extern int verify_index_checksum;
  776. extern int verify_ce_order;
  777. /* Environment bits from configuration mechanism */
  778. extern int trust_executable_bit;
  779. extern int trust_ctime;
  780. extern int check_stat;
  781. extern int quote_path_fully;
  782. extern int has_symlinks;
  783. extern int minimum_abbrev, default_abbrev;
  784. extern int ignore_case;
  785. extern int assume_unchanged;
  786. extern int prefer_symlink_refs;
  787. extern int warn_ambiguous_refs;
  788. extern int warn_on_object_refname_ambiguity;
  789. extern const char *apply_default_whitespace;
  790. extern const char *apply_default_ignorewhitespace;
  791. extern const char *git_attributes_file;
  792. extern const char *git_hooks_path;
  793. extern int zlib_compression_level;
  794. extern int core_compression_level;
  795. extern int pack_compression_level;
  796. extern size_t packed_git_window_size;
  797. extern size_t packed_git_limit;
  798. extern size_t delta_base_cache_limit;
  799. extern unsigned long big_file_threshold;
  800. extern unsigned long pack_size_limit_cfg;
  801. /*
  802. * Accessors for the core.sharedrepository config which lazy-load the value
  803. * from the config (if not already set). The "reset" function can be
  804. * used to unset "set" or cached value, meaning that the value will be loaded
  805. * fresh from the config file on the next call to get_shared_repository().
  806. */
  807. void set_shared_repository(int value);
  808. int get_shared_repository(void);
  809. void reset_shared_repository(void);
  810. /*
  811. * Do replace refs need to be checked this run? This variable is
  812. * initialized to true unless --no-replace-object is used or
  813. * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
  814. * commands that do not want replace references to be active.
  815. */
  816. extern int read_replace_refs;
  817. extern char *git_replace_ref_base;
  818. extern int fsync_object_files;
  819. extern int core_preload_index;
  820. extern int core_apply_sparse_checkout;
  821. extern int precomposed_unicode;
  822. extern int protect_hfs;
  823. extern int protect_ntfs;
  824. extern const char *core_fsmonitor;
  825. /*
  826. * Include broken refs in all ref iterations, which will
  827. * generally choke dangerous operations rather than letting
  828. * them silently proceed without taking the broken ref into
  829. * account.
  830. */
  831. extern int ref_paranoia;
  832. /*
  833. * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
  834. */
  835. int use_optional_locks(void);
  836. /*
  837. * The character that begins a commented line in user-editable file
  838. * that is subject to stripspace.
  839. */
  840. extern char comment_line_char;
  841. extern int auto_comment_line_char;
  842. enum log_refs_config {
  843. LOG_REFS_UNSET = -1,
  844. LOG_REFS_NONE = 0,
  845. LOG_REFS_NORMAL,
  846. LOG_REFS_ALWAYS
  847. };
  848. extern enum log_refs_config log_all_ref_updates;
  849. enum rebase_setup_type {
  850. AUTOREBASE_NEVER = 0,
  851. AUTOREBASE_LOCAL,
  852. AUTOREBASE_REMOTE,
  853. AUTOREBASE_ALWAYS
  854. };
  855. enum push_default_type {
  856. PUSH_DEFAULT_NOTHING = 0,
  857. PUSH_DEFAULT_MATCHING,
  858. PUSH_DEFAULT_SIMPLE,
  859. PUSH_DEFAULT_UPSTREAM,
  860. PUSH_DEFAULT_CURRENT,
  861. PUSH_DEFAULT_UNSPECIFIED
  862. };
  863. extern enum rebase_setup_type autorebase;
  864. extern enum push_default_type push_default;
  865. enum object_creation_mode {
  866. OBJECT_CREATION_USES_HARDLINKS = 0,
  867. OBJECT_CREATION_USES_RENAMES = 1
  868. };
  869. extern enum object_creation_mode object_creation_mode;
  870. extern char *notes_ref_name;
  871. extern int grafts_replace_parents;
  872. /*
  873. * GIT_REPO_VERSION is the version we write by default. The
  874. * _READ variant is the highest number we know how to
  875. * handle.
  876. */
  877. #define GIT_REPO_VERSION 0
  878. #define GIT_REPO_VERSION_READ 1
  879. extern int repository_format_precious_objects;
  880. extern int repository_format_worktree_config;
  881. /*
  882. * You _have_ to initialize a `struct repository_format` using
  883. * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
  884. */
  885. struct repository_format {
  886. int version;
  887. int precious_objects;
  888. char *partial_clone; /* value of extensions.partialclone */
  889. int worktree_config;
  890. int is_bare;
  891. int hash_algo;
  892. char *work_tree;
  893. struct string_list unknown_extensions;
  894. };
  895. /*
  896. * Always use this to initialize a `struct repository_format`
  897. * to a well-defined, default state before calling
  898. * `read_repository()`.
  899. */
  900. #define REPOSITORY_FORMAT_INIT \
  901. { \
  902. .version = -1, \
  903. .is_bare = -1, \
  904. .hash_algo = GIT_HASH_SHA1, \
  905. .unknown_extensions = STRING_LIST_INIT_DUP, \
  906. }
  907. /*
  908. * Read the repository format characteristics from the config file "path" into
  909. * "format" struct. Returns the numeric version. On error, or if no version is
  910. * found in the configuration, -1 is returned, format->version is set to -1,
  911. * and all other fields in the struct are set to the default configuration
  912. * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
  913. * REPOSITORY_FORMAT_INIT before calling this function.
  914. */
  915. int read_repository_format(struct repository_format *format, const char *path);
  916. /*
  917. * Free the memory held onto by `format`, but not the struct itself.
  918. * (No need to use this after `read_repository_format()` fails.)
  919. */
  920. void clear_repository_format(struct repository_format *format);
  921. /*
  922. * Verify that the repository described by repository_format is something we
  923. * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
  924. * any errors encountered.
  925. */
  926. int verify_repository_format(const struct repository_format *format,
  927. struct strbuf *err);
  928. /*
  929. * Check the repository format version in the path found in get_git_dir(),
  930. * and die if it is a version we don't understand. Generally one would
  931. * set_git_dir() before calling this, and use it only for "are we in a valid
  932. * repo?".
  933. */
  934. void check_repository_format(void);
  935. #define MTIME_CHANGED 0x0001
  936. #define CTIME_CHANGED 0x0002
  937. #define OWNER_CHANGED 0x0004
  938. #define MODE_CHANGED 0x0008
  939. #define INODE_CHANGED 0x0010
  940. #define DATA_CHANGED 0x0020
  941. #define TYPE_CHANGED 0x0040
  942. /*
  943. * Return an abbreviated sha1 unique within this repository's object database.
  944. * The result will be at least `len` characters long, and will be NUL
  945. * terminated.
  946. *
  947. * The non-`_r` version returns a static buffer which remains valid until 4
  948. * more calls to find_unique_abbrev are made.
  949. *
  950. * The `_r` variant writes to a buffer supplied by the caller, which must be at
  951. * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
  952. * written (excluding the NUL terminator).
  953. *
  954. * Note that while this version avoids the static buffer, it is not fully
  955. * reentrant, as it calls into other non-reentrant git code.
  956. */
  957. const char *repo_find_unique_abbrev(struct repository *r, const struct object_id *oid, int len);
  958. #define find_unique_abbrev(oid, len) repo_find_unique_abbrev(the_repository, oid, len)
  959. int repo_find_unique_abbrev_r(struct repository *r, char *hex, const struct object_id *oid, int len);
  960. #define find_unique_abbrev_r(hex, oid, len) repo_find_unique_abbrev_r(the_repository, hex, oid, len)
  961. extern const struct object_id null_oid;
  962. static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
  963. {
  964. /*
  965. * Teach the compiler that there are only two possibilities of hash size
  966. * here, so that it can optimize for this case as much as possible.
  967. */
  968. if (the_hash_algo->rawsz == GIT_MAX_RAWSZ)
  969. return memcmp(sha1, sha2, GIT_MAX_RAWSZ);
  970. return memcmp(sha1, sha2, GIT_SHA1_RAWSZ);
  971. }
  972. static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
  973. {
  974. return hashcmp(oid1->hash, oid2->hash);
  975. }
  976. static inline int hasheq(const unsigned char *sha1, const unsigned char *sha2)
  977. {
  978. /*
  979. * We write this here instead of deferring to hashcmp so that the
  980. * compiler can properly inline it and avoid calling memcmp.
  981. */
  982. if (the_hash_algo->rawsz == GIT_MAX_RAWSZ)
  983. return !memcmp(sha1, sha2, GIT_MAX_RAWSZ);
  984. return !memcmp(sha1, sha2, GIT_SHA1_RAWSZ);
  985. }
  986. static inline int oideq(const struct object_id *oid1, const struct object_id *oid2)
  987. {
  988. return hasheq(oid1->hash, oid2->hash);
  989. }
  990. static inline int is_null_oid(const struct object_id *oid)
  991. {
  992. return oideq(oid, &null_oid);
  993. }
  994. static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
  995. {
  996. memcpy(sha_dst, sha_src, the_hash_algo->rawsz);
  997. }
  998. static inline void oidcpy(struct object_id *dst, const struct object_id *src)
  999. {
  1000. memcpy(dst->hash, src->hash, GIT_MAX_RAWSZ);
  1001. }
  1002. static inline struct object_id *oiddup(const struct object_id *src)
  1003. {
  1004. struct object_id *dst = xmalloc(sizeof(struct object_id));
  1005. oidcpy(dst, src);
  1006. return dst;
  1007. }
  1008. static inline void hashclr(unsigned char *hash)
  1009. {
  1010. memset(hash, 0, the_hash_algo->rawsz);
  1011. }
  1012. static inline void oidclr(struct object_id *oid)
  1013. {
  1014. memset(oid->hash, 0, GIT_MAX_RAWSZ);
  1015. }
  1016. static inline void oidread(struct object_id *oid, const unsigned char *hash)
  1017. {
  1018. memcpy(oid->hash, hash, the_hash_algo->rawsz);
  1019. }
  1020. static inline int is_empty_blob_sha1(const unsigned char *sha1)
  1021. {
  1022. return hasheq(sha1, the_hash_algo->empty_blob->hash);
  1023. }
  1024. static inline int is_empty_blob_oid(const struct object_id *oid)
  1025. {
  1026. return oideq(oid, the_hash_algo->empty_blob);
  1027. }
  1028. static inline int is_empty_tree_sha1(const unsigned char *sha1)
  1029. {
  1030. return hasheq(sha1, the_hash_algo->empty_tree->hash);
  1031. }
  1032. static inline int is_empty_tree_oid(const struct object_id *oid)
  1033. {
  1034. return oideq(oid, the_hash_algo->empty_tree);
  1035. }
  1036. const char *empty_tree_oid_hex(void);
  1037. const char *empty_blob_oid_hex(void);
  1038. /* set default permissions by passing mode arguments to open(2) */
  1039. int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
  1040. int git_mkstemp_mode(char *pattern, int mode);
  1041. /*
  1042. * NOTE NOTE NOTE!!
  1043. *
  1044. * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
  1045. * not be changed. Old repositories have core.sharedrepository written in
  1046. * numeric format, and therefore these values are preserved for compatibility
  1047. * reasons.
  1048. */
  1049. enum sharedrepo {
  1050. PERM_UMASK = 0,
  1051. OLD_PERM_GROUP = 1,
  1052. OLD_PERM_EVERYBODY = 2,
  1053. PERM_GROUP = 0660,
  1054. PERM_EVERYBODY = 0664
  1055. };
  1056. int git_config_perm(const char *var, const char *value);
  1057. int adjust_shared_perm(const char *path);
  1058. /*
  1059. * Create the directory containing the named path, using care to be
  1060. * somewhat safe against races. Return one of the scld_error values to
  1061. * indicate success/failure. On error, set errno to describe the
  1062. * problem.
  1063. *
  1064. * SCLD_VANISHED indicates that one of the ancestor directories of the
  1065. * path existed at one point during the function call and then
  1066. * suddenly vanished, probably because another process pruned the
  1067. * directory while we were working. To be robust against this kind of
  1068. * race, callers might want to try invoking the function again when it
  1069. * returns SCLD_VANISHED.
  1070. *
  1071. * safe_create_leading_directories() temporarily changes path while it
  1072. * is working but restores it before returning.
  1073. * safe_create_leading_directories_const() doesn't modify path, even
  1074. * temporarily.
  1075. */
  1076. enum scld_error {
  1077. SCLD_OK = 0,
  1078. SCLD_FAILED = -1,
  1079. SCLD_PERMS = -2,
  1080. SCLD_EXISTS = -3,
  1081. SCLD_VANISHED = -4
  1082. };
  1083. enum scld_error safe_create_leading_directories(char *path);
  1084. enum scld_error safe_create_leading_directories_const(const char *path);
  1085. /*
  1086. * Callback function for raceproof_create_file(). This function is
  1087. * expected to do something that makes dirname(path) permanent despite
  1088. * the fact that other processes might be cleaning up empty
  1089. * directories at the same time. Usually it will create a file named
  1090. * path, but alternatively it could create another file in that
  1091. * directory, or even chdir() into that directory. The function should
  1092. * return 0 if the action was completed successfully. On error, it
  1093. * should return a nonzero result and set errno.
  1094. * raceproof_create_file() treats two errno values specially:
  1095. *
  1096. * - ENOENT -- dirname(path) does not exist. In this case,
  1097. * raceproof_create_file() tries creating dirname(path)
  1098. * (and any parent directories, if necessary) and calls
  1099. * the function again.
  1100. *
  1101. * - EISDIR -- the file already exists and is a directory. In this
  1102. * case, raceproof_create_file() removes the directory if
  1103. * it is empty (and recursively any empty directories that
  1104. * it contains) and calls the function again.
  1105. *
  1106. * Any other errno causes raceproof_create_file() to fail with the
  1107. * callback's return value and errno.
  1108. *
  1109. * Obviously, this function should be OK with being called again if it
  1110. * fails with ENOENT or EISDIR. In other scenarios it will not be
  1111. * called again.
  1112. */
  1113. typedef int create_file_fn(const char *path, void *cb);
  1114. /*
  1115. * Create a file in dirname(path) by calling fn, creating leading
  1116. * directories if necessary. Retry a few times in case we are racing
  1117. * with another process that is trying to clean up the directory that
  1118. * contains path. See the documentation for create_file_fn for more
  1119. * details.
  1120. *
  1121. * Return the value and set the errno that resulted from the most
  1122. * recent call of fn. fn is always called at least once, and will be
  1123. * called more than once if it returns ENOENT or EISDIR.
  1124. */
  1125. int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
  1126. int mkdir_in_gitdir(const char *path);
  1127. char *expand_user_path(const char *path, int real_home);
  1128. const char *enter_repo(const char *path, int strict);
  1129. static inline int is_absolute_path(const char *path)
  1130. {
  1131. return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
  1132. }
  1133. int is_directory(const char *);
  1134. char *strbuf_realpath(struct strbuf *resolved, const char *path,
  1135. int die_on_error);
  1136. const char *real_path(const char *path);
  1137. const char *real_path_if_valid(const char *path);
  1138. char *real_pathdup(const char *path, int die_on_error);
  1139. const char *absolute_path(const char *path);
  1140. char *absolute_pathdup(const char *path);
  1141. const char *remove_leading_path(const char *in, const char *prefix);
  1142. const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
  1143. int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
  1144. int normalize_path_copy(char *dst, const char *src);
  1145. int longest_ancestor_length(const char *path, struct string_list *prefixes);
  1146. char *strip_path_suffix(const char *path, const char *suffix);
  1147. int daemon_avoid_alias(const char *path);
  1148. /*
  1149. * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
  1150. * details.
  1151. */
  1152. int is_ntfs_dotgit(const char *name);
  1153. int is_ntfs_dotgitmodules(const char *name);
  1154. int is_ntfs_dotgitignore(const char *name);
  1155. int is_ntfs_dotgitattributes(const char *name);
  1156. /*
  1157. * Returns true iff "str" could be confused as a command-line option when
  1158. * passed to a sub-program like "ssh". Note that this has nothing to do with
  1159. * shell-quoting, which should be handled separately; we're assuming here that
  1160. * the string makes it verbatim to the sub-program.
  1161. */
  1162. int looks_like_command_line_option(const char *str);
  1163. /**
  1164. * Return a newly allocated string with the evaluation of
  1165. * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
  1166. * "$HOME/.config/git/$filename". Return NULL upon error.
  1167. */
  1168. char *xdg_config_home(const char *filename);
  1169. /**
  1170. * Return a newly allocated string with the evaluation of
  1171. * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
  1172. * "$HOME/.cache/git/$filename". Return NULL upon error.
  1173. */
  1174. char *xdg_cache_home(const char *filename);
  1175. int git_open_cloexec(const char *name, int flags);
  1176. #define git_open(name) git_open_cloexec(name, O_RDONLY)
  1177. int unpack_loose_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
  1178. int parse_loose_header(const char *hdr, unsigned long *sizep);
  1179. int check_object_signature(const struct object_id *oid, void *buf, unsigned long size, const char *type);
  1180. int finalize_object_file(const char *tmpfile, const char *filename);
  1181. /* Helper to check and "touch" a file */
  1182. int check_and_freshen_file(const char *fn, int freshen);
  1183. extern const signed char hexval_table[256];
  1184. static inline unsigned int hexval(unsigned char c)
  1185. {
  1186. return hexval_table[c];
  1187. }
  1188. /*
  1189. * Convert two consecutive hexadecimal digits into a char. Return a
  1190. * negative value on error. Don't run over the end of short strings.
  1191. */
  1192. static inline int hex2chr(const char *s)
  1193. {
  1194. unsigned int val = hexval(s[0]);
  1195. return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
  1196. }
  1197. /* Convert to/from hex/sha1 representation */
  1198. #define MINIMUM_ABBREV minimum_abbrev
  1199. #define DEFAULT_ABBREV default_abbrev
  1200. /* used when the code does not know or care what the default abbrev is */
  1201. #define FALLBACK_DEFAULT_ABBREV 7
  1202. struct object_context {
  1203. unsigned short mode;
  1204. /*
  1205. * symlink_path is only used by get_tree_entry_follow_symlinks,
  1206. * and only for symlinks that point outside the repository.
  1207. */
  1208. struct strbuf symlink_path;
  1209. /*
  1210. * If GET_OID_RECORD_PATH is set, this will record path (if any)
  1211. * found when resolving the name. The caller is responsible for
  1212. * releasing the memory.
  1213. */
  1214. char *path;
  1215. };
  1216. #define GET_OID_QUIETLY 01
  1217. #define GET_OID_COMMIT 02
  1218. #define GET_OID_COMMITTISH 04
  1219. #define GET_OID_TREE 010
  1220. #define GET_OID_TREEISH 020
  1221. #define GET_OID_BLOB 040
  1222. #define GET_OID_FOLLOW_SYMLINKS 0100
  1223. #define GET_OID_RECORD_PATH 0200
  1224. #define GET_OID_ONLY_TO_DIE 04000
  1225. #define GET_OID_DISAMBIGUATORS \
  1226. (GET_OID_COMMIT | GET_OID_COMMITTISH | \
  1227. GET_OID_TREE | GET_OID_TREEISH | \
  1228. GET_OID_BLOB)
  1229. enum get_oid_result {
  1230. FOUND = 0,
  1231. MISSING_OBJECT = -1, /* The requested object is missing */
  1232. SHORT_NAME_AMBIGUOUS = -2,
  1233. /* The following only apply when symlinks are followed */
  1234. DANGLING_SYMLINK = -4, /*
  1235. * The initial symlink is there, but
  1236. * (transitively) points to a missing
  1237. * in-tree file
  1238. */
  1239. SYMLINK_LOOP = -5,
  1240. NOT_DIR = -6, /*
  1241. * Somewhere along the symlink chain, a path is
  1242. * requested which contains a file as a
  1243. * non-final element.
  1244. */
  1245. };
  1246. int repo_get_oid(struct repository *r, const char *str, struct object_id *oid);
  1247. int get_oidf(struct object_id *oid, const char *fmt, ...);
  1248. int repo_get_oid_commit(struct repository *r, const char *str, struct object_id *oid);
  1249. int repo_get_oid_committish(struct repository *r, const char *str, struct object_id *oid);
  1250. int repo_get_oid_tree(struct repository *r, const char *str, struct object_id *oid);
  1251. int repo_get_oid_treeish(struct repository *r, const char *str, struct object_id *oid);
  1252. int repo_get_oid_blob(struct repository *r, const char *str, struct object_id *oid);
  1253. int repo_get_oid_mb(struct repository *r, const char *str, struct object_id *oid);
  1254. void maybe_die_on_misspelt_object_name(struct repository *repo,
  1255. const char *name,
  1256. const char *prefix);
  1257. enum get_oid_result get_oid_with_context(struct repository *repo, const char *str,
  1258. unsigned flags, struct object_id *oid,
  1259. struct object_context *oc);
  1260. #define get_oid(str, oid) repo_get_oid(the_repository, str, oid)
  1261. #define get_oid_commit(str, oid) repo_get_oid_commit(the_repository, str, oid)
  1262. #define get_oid_committish(str, oid) repo_get_oid_committish(the_repository, str, oid)
  1263. #define get_oid_tree(str, oid) repo_get_oid_tree(the_repository, str, oid)
  1264. #define get_oid_treeish(str, oid) repo_get_oid_treeish(the_repository, str, oid)
  1265. #define get_oid_blob(str, oid) repo_get_oid_blob(the_repository, str, oid)
  1266. #define get_oid_mb(str, oid) repo_get_oid_mb(the_repository, str, oid)
  1267. typedef int each_abbrev_fn(const struct object_id *oid, void *);
  1268. int repo_for_each_abbrev(struct repository *r, const char *prefix, each_abbrev_fn, void *);
  1269. #define for_each_abbrev(prefix, fn, data) repo_for_each_abbrev(the_repository, prefix, fn, data)
  1270. int set_disambiguate_hint_config(const char *var, const char *value);
  1271. /*
  1272. * Try to read a SHA1 in hexadecimal format from the 40 characters
  1273. * starting at hex. Write the 20-byte result to sha1 in binary form.
  1274. * Return 0 on success. Reading stops if a NUL is encountered in the
  1275. * input, so it is safe to pass this function an arbitrary
  1276. * null-terminated string.
  1277. */
  1278. int get_sha1_hex(const char *hex, unsigned char *sha1);
  1279. int get_oid_hex(const char *hex, struct object_id *sha1);
  1280. /*
  1281. * Read `len` pairs of hexadecimal digits from `hex` and write the
  1282. * values to `binary` as `len` bytes. Return 0 on success, or -1 if
  1283. * the input does not consist of hex digits).
  1284. */
  1285. int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
  1286. /*
  1287. * Convert a binary hash to its hex equivalent. The `_r` variant is reentrant,
  1288. * and writes the NUL-terminated output to the buffer `out`, which must be at
  1289. * least `GIT_MAX_HEXSZ + 1` bytes, and returns a pointer to out for
  1290. * convenience.
  1291. *
  1292. * The non-`_r` variant returns a static buffer, but uses a ring of 4
  1293. * buffers, making it safe to make multiple calls for a single statement, like:
  1294. *
  1295. * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
  1296. */
  1297. char *hash_to_hex_algop_r(char *buffer, const unsigned char *hash, const struct git_hash_algo *);
  1298. char *sha1_to_hex_r(char *out, const unsigned char *sha1);
  1299. char *oid_to_hex_r(char *out, const struct object_id *oid);
  1300. char *hash_to_hex_algop(const unsigned char *hash, const struct git_hash_algo *); /* static buffer result! */
  1301. char *sha1_to_hex(const unsigned char *sha1); /* same static buffer */
  1302. char *hash_to_hex(const unsigned char *hash); /* same static buffer */
  1303. char *oid_to_hex(const struct object_id *oid); /* same static buffer */
  1304. /*
  1305. * Parse a 40-character hexadecimal object ID starting from hex, updating the
  1306. * pointer specified by end when parsing stops. The resulting object ID is
  1307. * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
  1308. * other invalid character. end is only updated on success; otherwise, it is
  1309. * unmodified.
  1310. */
  1311. int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
  1312. /*
  1313. * This reads short-hand syntax that not only evaluates to a commit
  1314. * object name, but also can act as if the end user spelled the name
  1315. * of the branch from the command line.
  1316. *
  1317. * - "@{-N}" finds the name of the Nth previous branch we were on, and
  1318. * places the name of the branch in the given buf and returns the
  1319. * number of characters parsed if successful.
  1320. *
  1321. * - "<branch>@{upstream}" finds the name of the other ref that
  1322. * <branch> is configured to merge with (missing <branch> defaults
  1323. * to the current branch), and places the name of the branch in the
  1324. * given buf and returns the number of characters parsed if
  1325. * successful.
  1326. *
  1327. * If the input is not of the accepted format, it returns a negative
  1328. * number to signal an error.
  1329. *
  1330. * If the input was ok but there are not N branch switches in the
  1331. * reflog, it returns 0.
  1332. *
  1333. * If "allowed" is non-zero, it is a treated as a bitfield of allowable
  1334. * expansions: local branches ("refs/heads/"), remote branches
  1335. * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
  1336. * allowed, even ones to refs outside of those namespaces.
  1337. */
  1338. #define INTERPRET_BRANCH_LOCAL (1<<0)
  1339. #define INTERPRET_BRANCH_REMOTE (1<<1)
  1340. #define INTERPRET_BRANCH_HEAD (1<<2)
  1341. int repo_interpret_branch_name(struct repository *r,
  1342. const char *str, int len,
  1343. struct strbuf *buf,
  1344. unsigned allowed);
  1345. #define interpret_branch_name(str, len, buf, allowed) \
  1346. repo_interpret_branch_name(the_repository, str, len, buf, allowed)
  1347. int validate_headref(const char *ref);
  1348. int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
  1349. int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
  1350. int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
  1351. int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
  1352. void *read_object_with_reference(struct repository *r,
  1353. const struct object_id *oid,
  1354. const char *required_type,
  1355. unsigned long *size,
  1356. struct object_id *oid_ret);
  1357. struct object *repo_peel_to_type(struct repository *r,
  1358. const char *name, int namelen,
  1359. struct object *o, enum object_type);
  1360. #define peel_to_type(name, namelen, obj, type) \
  1361. repo_peel_to_type(the_repository, name, namelen, obj, type)
  1362. enum date_mode_type {
  1363. DATE_NORMAL = 0,
  1364. DATE_HUMAN,
  1365. DATE_RELATIVE,
  1366. DATE_SHORT,
  1367. DATE_ISO8601,
  1368. DATE_ISO8601_STRICT,
  1369. DATE_RFC2822,
  1370. DATE_STRFTIME,
  1371. DATE_RAW,
  1372. DATE_UNIX
  1373. };
  1374. struct date_mode {
  1375. enum date_mode_type type;
  1376. const char *strftime_fmt;
  1377. int local;
  1378. };
  1379. /*
  1380. * Convenience helper for passing a constant type, like:
  1381. *
  1382. * show_date(t, tz, DATE_MODE(NORMAL));
  1383. */
  1384. #define DATE_MODE(t) date_mode_from_type(DATE_##t)
  1385. struct date_mode *date_mode_from_type(enum date_mode_type type);
  1386. const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
  1387. void show_date_relative(timestamp_t time, struct strbuf *timebuf);
  1388. void show_date_human(timestamp_t time, int tz, const struct timeval *now,
  1389. struct strbuf *timebuf);
  1390. int parse_date(const char *date, struct strbuf *out);
  1391. int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
  1392. int parse_expiry_date(const char *date, timestamp_t *timestamp);
  1393. void datestamp(struct strbuf *out);
  1394. #define approxidate(s) approxidate_careful((s), NULL)
  1395. timestamp_t approxidate_careful(const char *, int *);
  1396. timestamp_t approxidate_relative(const char *date);
  1397. void parse_date_format(const char *format, struct date_mode *mode);
  1398. int date_overflows(timestamp_t date);
  1399. #define IDENT_STRICT 1
  1400. #define IDENT_NO_DATE 2
  1401. #define IDENT_NO_NAME 4
  1402. enum want_ident {
  1403. WANT_BLANK_IDENT,
  1404. WANT_AUTHOR_IDENT,
  1405. WANT_COMMITTER_IDENT
  1406. };
  1407. const char *git_author_info(int);
  1408. const char *git_committer_info(int);
  1409. const char *fmt_ident(const char *name, const char *email,
  1410. enum want_ident whose_ident,
  1411. const char *date_str, int);
  1412. const char *fmt_name(enum want_ident);
  1413. const char *ident_default_name(void);
  1414. const char *ident_default_email(void);
  1415. const char *git_editor(void);
  1416. const char *git_sequence_editor(void);
  1417. const char *git_pager(int stdout_is_tty);
  1418. int is_terminal_dumb(void);
  1419. int git_ident_config(const char *, const char *, void *);
  1420. /*
  1421. * Prepare an ident to fall back on if the user didn't configure it.
  1422. */
  1423. void prepare_fallback_ident(const char *name, const char *email);
  1424. void reset_ident_date(void);
  1425. struct ident_split {
  1426. const char *name_begin;
  1427. const char *name_end;
  1428. const char *mail_begin;
  1429. const char *mail_end;
  1430. const char *date_begin;
  1431. const char *date_end;
  1432. const char *tz_begin;
  1433. const char *tz_end;
  1434. };
  1435. /*
  1436. * Signals an success with 0, but time part of the result may be NULL
  1437. * if the input lacks timestamp and zone
  1438. */
  1439. int split_ident_line(struct ident_split *, const char *, int);
  1440. /*
  1441. * Like show_date, but pull the timestamp and tz parameters from
  1442. * the ident_split. It will also sanity-check the values and produce
  1443. * a well-known sentinel date if they appear bogus.
  1444. */
  1445. const char *show_ident_date(const struct ident_split *id,
  1446. const struct date_mode *mode);
  1447. /*
  1448. * Compare split idents for equality or strict ordering. Note that we
  1449. * compare only the ident part of the line, ignoring any timestamp.
  1450. *
  1451. * Because there are two fields, we must choose one as the primary key; we
  1452. * currently arbitrarily pick the email.
  1453. */
  1454. int ident_cmp(const struct ident_split *, const struct ident_split *);
  1455. struct checkout {
  1456. struct index_state *istate;
  1457. const char *base_dir;
  1458. int base_dir_len;
  1459. struct delayed_checkout *delayed_checkout;
  1460. unsigned force:1,
  1461. quiet:1,
  1462. not_new:1,
  1463. clone:1,
  1464. refresh_cache:1;
  1465. };
  1466. #define CHECKOUT_INIT { NULL, "" }
  1467. #define TEMPORARY_FILENAME_LENGTH 25
  1468. int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath, int *nr_checkouts);
  1469. void enable_delayed_checkout(struct checkout *state);
  1470. int finish_delayed_checkout(struct checkout *state, int *nr_checkouts);
  1471. /*
  1472. * Unlink the last component and schedule the leading directories for
  1473. * removal, such that empty directories get removed.
  1474. */
  1475. void unlink_entry(const struct cache_entry *ce);
  1476. struct cache_def {
  1477. struct strbuf path;
  1478. int flags;
  1479. int track_flags;
  1480. int prefix_len_stat_func;
  1481. };
  1482. #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
  1483. static inline void cache_def_clear(struct cache_def *cache)
  1484. {
  1485. strbuf_release(&cache->path);
  1486. }
  1487. int has_symlink_leading_path(const char *name, int len);
  1488. int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
  1489. int check_leading_path(const char *name, int len);
  1490. int has_dirs_only_path(const char *name, int len, int prefix_len);
  1491. void schedule_dir_for_removal(const char *name, int len);
  1492. void remove_scheduled_dirs(void);
  1493. struct pack_window {
  1494. struct pack_window *next;
  1495. unsigned char *base;
  1496. off_t offset;
  1497. size_t len;
  1498. unsigned int last_used;
  1499. unsigned int inuse_cnt;
  1500. };
  1501. struct pack_entry {
  1502. off_t offset;
  1503. struct packed_git *p;
  1504. };
  1505. /*
  1506. * Create a temporary file rooted in the object database directory, or
  1507. * die on failure. The filename is taken from "pattern", which should have the
  1508. * usual "XXXXXX" trailer, and the resulting filename is written into the
  1509. * "template" buffer. Returns the open descriptor.
  1510. */
  1511. int odb_mkstemp(struct strbuf *temp_filename, const char *pattern);
  1512. /*
  1513. * Create a pack .keep file named "name" (which should generally be the output
  1514. * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
  1515. * error.
  1516. */
  1517. int odb_pack_keep(const char *name);
  1518. /*
  1519. * Set this to 0 to prevent oid_object_info_extended() from fetching missing
  1520. * blobs. This has a difference only if extensions.partialClone is set.
  1521. *
  1522. * Its default value is 1.
  1523. */
  1524. extern int fetch_if_missing;
  1525. /* Dumb servers support */
  1526. int update_server_info(int);
  1527. const char *get_log_output_encoding(void);
  1528. const char *get_commit_output_encoding(void);
  1529. /*
  1530. * This is a hack for test programs like test-dump-untracked-cache to
  1531. * ensure that they do not modify the untracked cache when reading it.
  1532. * Do not use it otherwise!
  1533. */
  1534. extern int ignore_untracked_cache_config;
  1535. int committer_ident_sufficiently_given(void);
  1536. int author_ident_sufficiently_given(void);
  1537. extern const char *git_commit_encoding;
  1538. extern const char *git_log_output_encoding;
  1539. extern const char *git_mailmap_file;
  1540. extern const char *git_mailmap_blob;
  1541. /* IO helper functions */
  1542. void maybe_flush_or_die(FILE *, const char *);
  1543. __attribute__((format (printf, 2, 3)))
  1544. void fprintf_or_die(FILE *, const char *fmt, ...);
  1545. #define COPY_READ_ERROR (-2)
  1546. #define COPY_WRITE_ERROR (-3)
  1547. int copy_fd(int ifd, int ofd);
  1548. int copy_file(const char *dst, const char *src, int mode);
  1549. int copy_file_with_time(const char *dst, const char *src, int mode);
  1550. void write_or_die(int fd, const void *buf, size_t count);
  1551. void fsync_or_die(int fd, const char *);
  1552. ssize_t read_in_full(int fd, void *buf, size_t count);
  1553. ssize_t write_in_full(int fd, const void *buf, size_t count);
  1554. ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
  1555. static inline ssize_t write_str_in_full(int fd, const char *str)
  1556. {
  1557. return write_in_full(fd, str, strlen(str));
  1558. }
  1559. /**
  1560. * Open (and truncate) the file at path, write the contents of buf to it,
  1561. * and close it. Dies if any errors are encountered.
  1562. */
  1563. void write_file_buf(const char *path, const char *buf, size_t len);
  1564. /**
  1565. * Like write_file_buf(), but format the contents into a buffer first.
  1566. * Additionally, write_file() will append a newline if one is not already
  1567. * present, making it convenient to write text files:
  1568. *
  1569. * write_file(path, "counter: %d", ctr);
  1570. */
  1571. __attribute__((format (printf, 2, 3)))
  1572. void write_file(const char *path, const char *fmt, ...);
  1573. /* pager.c */
  1574. void setup_pager(void);
  1575. int pager_in_use(void);
  1576. extern int pager_use_color;
  1577. int term_columns(void);
  1578. void term_clear_line(void);
  1579. int decimal_width(uintmax_t);
  1580. int check_pager_config(const char *cmd);
  1581. void prepare_pager_args(struct child_process *, const char *pager);
  1582. extern const char *editor_program;
  1583. extern const char *askpass_program;
  1584. extern const char *excludes_file;
  1585. /* base85 */
  1586. int decode_85(char *dst, const char *line, int linelen);
  1587. void encode_85(char *buf, const unsigned char *data, int bytes);
  1588. /* pkt-line.c */
  1589. void packet_trace_identity(const char *prog);
  1590. /* add */
  1591. /*
  1592. * return 0 if success, 1 - if addition of a file failed and
  1593. * ADD_FILES_IGNORE_ERRORS was specified in flags
  1594. */
  1595. int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
  1596. /* diff.c */
  1597. extern int diff_auto_refresh_index;
  1598. /* match-trees.c */
  1599. void shift_tree(struct repository *, const struct object_id *, const struct object_id *, struct object_id *, int);
  1600. void shift_tree_by(struct repository *, const struct object_id *, const struct object_id *, struct object_id *, const char *);
  1601. /*
  1602. * whitespace rules.
  1603. * used by both diff and apply
  1604. * last two digits are tab width
  1605. */
  1606. #define WS_BLANK_AT_EOL 0100
  1607. #define WS_SPACE_BEFORE_TAB 0200
  1608. #define WS_INDENT_WITH_NON_TAB 0400
  1609. #define WS_CR_AT_EOL 01000
  1610. #define WS_BLANK_AT_EOF 02000
  1611. #define WS_TAB_IN_INDENT 04000
  1612. #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
  1613. #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
  1614. #define WS_TAB_WIDTH_MASK 077
  1615. /* All WS_* -- when extended, adapt diff.c emit_symbol */
  1616. #define WS_RULE_MASK 07777
  1617. extern unsigned whitespace_rule_cfg;
  1618. unsigned whitespace_rule(struct index_state *, const char *);
  1619. unsigned parse_whitespace_rule(const char *);
  1620. unsigned ws_check(const char *line, int len, unsigned ws_rule);
  1621. void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
  1622. char *whitespace_error_string(unsigned ws);
  1623. void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
  1624. int ws_blank_line(const char *line, int len, unsigned ws_rule);
  1625. #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
  1626. /* ls-files */
  1627. void overlay_tree_on_index(struct index_state *istate,
  1628. const char *tree_name, const char *prefix);
  1629. /* setup.c */
  1630. struct startup_info {
  1631. int have_repository;
  1632. const char *prefix;
  1633. };
  1634. extern struct startup_info *startup_info;
  1635. /* merge.c */
  1636. struct commit_list;
  1637. int try_merge_command(struct repository *r,
  1638. const char *strategy, size_t xopts_nr,
  1639. const char **xopts, struct commit_list *common,
  1640. const char *head_arg, struct commit_list *remotes);
  1641. int checkout_fast_forward(struct repository *r,
  1642. const struct object_id *from,
  1643. const struct object_id *to,
  1644. int overwrite_ignore);
  1645. int sane_execvp(const char *file, char *const argv[]);
  1646. /*
  1647. * A struct to encapsulate the concept of whether a file has changed
  1648. * since we last checked it. This uses criteria similar to those used
  1649. * for the index.
  1650. */
  1651. struct stat_validity {
  1652. struct stat_data *sd;
  1653. };
  1654. void stat_validity_clear(struct stat_validity *sv);
  1655. /*
  1656. * Returns 1 if the path is a regular file (or a symlink to a regular
  1657. * file) and matches the saved stat_validity, 0 otherwise. A missing
  1658. * or inaccessible file is considered a match if the struct was just
  1659. * initialized, or if the previous update found an inaccessible file.
  1660. */
  1661. int stat_validity_check(struct stat_validity *sv, const char *path);
  1662. /*
  1663. * Update the stat_validity from a file opened at descriptor fd. If
  1664. * the file is missing, inaccessible, or not a regular file, then
  1665. * future calls to stat_validity_check will match iff one of those
  1666. * conditions continues to be true.
  1667. */
  1668. void stat_validity_update(struct stat_validity *sv, int fd);
  1669. int versioncmp(const char *s1, const char *s2);
  1670. void sleep_millisec(int millisec);
  1671. /*
  1672. * Create a directory and (if share is nonzero) adjust its permissions
  1673. * according to the shared_repository setting. Only use this for
  1674. * directories under $GIT_DIR. Don't use it for working tree
  1675. * directories.
  1676. */
  1677. void safe_create_dir(const char *dir, int share);
  1678. /*
  1679. * Should we print an ellipsis after an abbreviated SHA-1 value
  1680. * when doing diff-raw output or indicating a detached HEAD?
  1681. */
  1682. int print_sha1_ellipsis(void);
  1683. /* Return 1 if the file is empty or does not exists, 0 otherwise. */
  1684. int is_empty_or_missing_file(const char *filename);
  1685. #endif /* CACHE_H */