l10n: bg.po: Updated Bulgarian translation (3376t)
[git.git] / packfile.h
bloba7fca598d672b73010a5fb99e4507da4634002ff
1 #ifndef PACKFILE_H
2 #define PACKFILE_H
4 #include "oidset.h"
6 /*
7 * Generate the filename to be used for a pack file with checksum "sha1" and
8 * extension "ext". The result is written into the strbuf "buf", overwriting
9 * any existing contents. A pointer to buf->buf is returned as a convenience.
11 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
13 extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
16 * Return the name of the (local) packfile with the specified sha1 in
17 * its name. The return value is a pointer to memory that is
18 * overwritten each time this function is called.
20 extern char *sha1_pack_name(const unsigned char *sha1);
23 * Return the name of the (local) pack index file with the specified
24 * sha1 in its name. The return value is a pointer to memory that is
25 * overwritten each time this function is called.
27 extern char *sha1_pack_index_name(const unsigned char *sha1);
29 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
31 /* A hook to report invalid files in pack directory */
32 #define PACKDIR_FILE_PACK 1
33 #define PACKDIR_FILE_IDX 2
34 #define PACKDIR_FILE_GARBAGE 4
35 extern void (*report_garbage)(unsigned seen_bits, const char *path);
37 extern void prepare_packed_git(void);
38 extern void reprepare_packed_git(void);
39 extern void install_packed_git(struct packed_git *pack);
42 * Give a rough count of objects in the repository. This sacrifices accuracy
43 * for speed.
45 unsigned long approximate_object_count(void);
47 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
48 struct packed_git *packs);
50 extern void pack_report(void);
53 * mmap the index file for the specified packfile (if it is not
54 * already mmapped). Return 0 on success.
56 extern int open_pack_index(struct packed_git *);
59 * munmap the index file for the specified packfile (if it is
60 * currently mmapped).
62 extern void close_pack_index(struct packed_git *);
64 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
65 extern void close_pack_windows(struct packed_git *);
66 extern void close_all_packs(void);
67 extern void unuse_pack(struct pack_window **);
68 extern void clear_delta_base_cache(void);
69 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
72 * Make sure that a pointer access into an mmap'd index file is within bounds,
73 * and can provide at least 8 bytes of data.
75 * Note that this is only necessary for variable-length segments of the file
76 * (like the 64-bit extended offset table), as we compare the size to the
77 * fixed-length parts when we open the file.
79 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
82 * Return the SHA-1 of the nth object within the specified packfile.
83 * Open the index if it is not already open. The return value points
84 * at the SHA-1 within the mmapped index. Return NULL if there is an
85 * error.
87 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
89 * Like nth_packed_object_sha1, but write the data into the object specified by
90 * the the first argument. Returns the first argument on success, and NULL on
91 * error.
93 extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
96 * Return the offset of the nth object within the specified packfile.
97 * The index must already be opened.
99 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
102 * If the object named sha1 is present in the specified packfile,
103 * return its offset within the packfile; otherwise, return 0.
105 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
107 extern int is_pack_valid(struct packed_git *);
108 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
109 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
110 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
111 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
113 extern void release_pack_memory(size_t);
115 /* global flag to enable extra checks when accessing packed objects */
116 extern int do_check_packed_object_crc;
118 extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
120 extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
121 extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1);
123 extern int find_pack_entry(const unsigned char *sha1, struct pack_entry *e);
125 extern int has_sha1_pack(const unsigned char *sha1);
127 extern int has_pack_index(const unsigned char *sha1);
130 * Only iterate over packs obtained from the promisor remote.
132 #define FOR_EACH_OBJECT_PROMISOR_ONLY 2
135 * Iterate over packed objects in both the local
136 * repository and any alternates repositories (unless the
137 * FOR_EACH_OBJECT_LOCAL_ONLY flag, defined in cache.h, is set).
139 typedef int each_packed_object_fn(const struct object_id *oid,
140 struct packed_git *pack,
141 uint32_t pos,
142 void *data);
143 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
146 * Return 1 if an object in a promisor packfile is or refers to the given
147 * object, 0 otherwise.
149 extern int is_promisor_object(const struct object_id *oid);
151 #endif