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