sha1_name: convert struct min_abbrev_data to object_id
[git/git.git] / packfile.h
CommitLineData
4f39cd82
JT
1#ifndef PACKFILE_H
2#define PACKFILE_H
3
498f1f61
JT
4#include "oidset.h"
5
4f39cd82
JT
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.
10 *
11 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
12 */
13extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
14
15/*
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.
19 */
20extern char *sha1_pack_name(const unsigned char *sha1);
21
22/*
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.
26 */
27extern char *sha1_pack_index_name(const unsigned char *sha1);
28
0317f455
JT
29extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
30
0abe14f6
JT
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
35extern void (*report_garbage)(unsigned seen_bits, const char *path);
36
37extern void prepare_packed_git(void);
38extern void reprepare_packed_git(void);
e65f1862
JT
39extern void install_packed_git(struct packed_git *pack);
40
0abe14f6
JT
41/*
42 * Give a rough count of objects in the repository. This sacrifices accuracy
43 * for speed.
44 */
45unsigned long approximate_object_count(void);
46
d6fe0036
JT
47extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
48 struct packed_git *packs);
49
8e21176c
JT
50extern void pack_report(void);
51
0317f455
JT
52/*
53 * mmap the index file for the specified packfile (if it is not
54 * already mmapped). Return 0 on success.
55 */
56extern int open_pack_index(struct packed_git *);
57
3836d88a
JT
58/*
59 * munmap the index file for the specified packfile (if it is
60 * currently mmapped).
61 */
62extern void close_pack_index(struct packed_git *);
63
84f80ad5 64extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
3836d88a
JT
65extern void close_pack_windows(struct packed_git *);
66extern void close_all_packs(void);
97de1803 67extern void unuse_pack(struct pack_window **);
f1d8130b 68extern void clear_delta_base_cache(void);
9a428653 69extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
3836d88a 70
9e0f45f5
JT
71/*
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.
74 *
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.
78 */
79extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
80
d5a16761
JT
81/*
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.
86 */
87extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
88/*
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.
92 */
93extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
94
9e0f45f5
JT
95/*
96 * Return the offset of the nth object within the specified packfile.
97 * The index must already be opened.
98 */
99extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
d5a16761 100
a2551953
JT
101/*
102 * If the object named sha1 is present in the specified packfile,
103 * return its offset within the packfile; otherwise, return 0.
104 */
105extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
106
107extern int is_pack_valid(struct packed_git *);
f1d8130b 108extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
32b42e15 109extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
7b3aa75d 110extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
3588dd6e 111extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
32b42e15 112
f0e17e86
JT
113extern void release_pack_memory(size_t);
114
f1d8130b
JT
115/* global flag to enable extra checks when accessing packed objects */
116extern int do_check_packed_object_crc;
117
118extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
119
120extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
121extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1);
9e0f45f5 122
1a1e5d4f
JT
123extern int find_pack_entry(const unsigned char *sha1, struct pack_entry *e);
124
150e3001
JT
125extern int has_sha1_pack(const unsigned char *sha1);
126
f9a8672a
JT
127extern int has_pack_index(const unsigned char *sha1);
128
498f1f61
JT
129/*
130 * Only iterate over packs obtained from the promisor remote.
131 */
132#define FOR_EACH_OBJECT_PROMISOR_ONLY 2
133
7709f468
JT
134/*
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).
138 */
139typedef int each_packed_object_fn(const struct object_id *oid,
140 struct packed_git *pack,
141 uint32_t pos,
142 void *data);
143extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
144
498f1f61
JT
145/*
146 * Return 1 if an object in a promisor packfile is or refers to the given
147 * object, 0 otherwise.
148 */
149extern int is_promisor_object(const struct object_id *oid);
150
4f39cd82 151#endif