packfile: add repository argument to find_pack_entry
[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
0f90a9f2 37extern void prepare_packed_git(struct repository *r);
4c2a13b4 38extern void reprepare_packed_git(struct repository *r);
5babff16 39extern void install_packed_git(struct repository *r, struct packed_git *pack);
e65f1862 40
a80d72db
SB
41struct packed_git *get_packed_git(struct repository *r);
42struct list_head *get_packed_git_mru(struct repository *r);
43
0abe14f6
JT
44/*
45 * Give a rough count of objects in the repository. This sacrifices accuracy
46 * for speed.
47 */
48unsigned long approximate_object_count(void);
49
d6fe0036
JT
50extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
51 struct packed_git *packs);
52
8e21176c
JT
53extern void pack_report(void);
54
0317f455
JT
55/*
56 * mmap the index file for the specified packfile (if it is not
57 * already mmapped). Return 0 on success.
58 */
59extern int open_pack_index(struct packed_git *);
60
3836d88a
JT
61/*
62 * munmap the index file for the specified packfile (if it is
63 * currently mmapped).
64 */
65extern void close_pack_index(struct packed_git *);
66
84f80ad5 67extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
3836d88a 68extern void close_pack_windows(struct packed_git *);
d0b59866 69extern void close_all_packs(struct raw_object_store *o);
97de1803 70extern void unuse_pack(struct pack_window **);
f1d8130b 71extern void clear_delta_base_cache(void);
9a428653 72extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
3836d88a 73
9e0f45f5
JT
74/*
75 * Make sure that a pointer access into an mmap'd index file is within bounds,
76 * and can provide at least 8 bytes of data.
77 *
78 * Note that this is only necessary for variable-length segments of the file
79 * (like the 64-bit extended offset table), as we compare the size to the
80 * fixed-length parts when we open the file.
81 */
82extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
83
d5a16761
JT
84/*
85 * Return the SHA-1 of the nth object within the specified packfile.
86 * Open the index if it is not already open. The return value points
87 * at the SHA-1 within the mmapped index. Return NULL if there is an
88 * error.
89 */
90extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
91/*
92 * Like nth_packed_object_sha1, but write the data into the object specified by
93 * the the first argument. Returns the first argument on success, and NULL on
94 * error.
95 */
96extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
97
9e0f45f5
JT
98/*
99 * Return the offset of the nth object within the specified packfile.
100 * The index must already be opened.
101 */
102extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
d5a16761 103
a2551953
JT
104/*
105 * If the object named sha1 is present in the specified packfile,
106 * return its offset within the packfile; otherwise, return 0.
107 */
108extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
109
110extern int is_pack_valid(struct packed_git *);
f1d8130b 111extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
32b42e15 112extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
7b3aa75d 113extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
3588dd6e 114extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
32b42e15 115
f0e17e86
JT
116extern void release_pack_memory(size_t);
117
f1d8130b
JT
118/* global flag to enable extra checks when accessing packed objects */
119extern int do_check_packed_object_crc;
120
121extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
122
123extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
124extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1);
9e0f45f5 125
613b42f2
SB
126/*
127 * Iff a pack file in the given repository contains the object named by sha1,
128 * return true and store its location to e.
129 */
130#define find_pack_entry(r, s, e) find_pack_entry_##r(s, e)
131extern int find_pack_entry_the_repository(const unsigned char *sha1, struct pack_entry *e);
1a1e5d4f 132
150e3001
JT
133extern int has_sha1_pack(const unsigned char *sha1);
134
f9a8672a
JT
135extern int has_pack_index(const unsigned char *sha1);
136
498f1f61
JT
137/*
138 * Only iterate over packs obtained from the promisor remote.
139 */
140#define FOR_EACH_OBJECT_PROMISOR_ONLY 2
141
7709f468
JT
142/*
143 * Iterate over packed objects in both the local
144 * repository and any alternates repositories (unless the
145 * FOR_EACH_OBJECT_LOCAL_ONLY flag, defined in cache.h, is set).
146 */
147typedef int each_packed_object_fn(const struct object_id *oid,
148 struct packed_git *pack,
149 uint32_t pos,
150 void *data);
151extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
152
498f1f61
JT
153/*
154 * Return 1 if an object in a promisor packfile is or refers to the given
155 * object, 0 otherwise.
156 */
157extern int is_promisor_object(const struct object_id *oid);
158
4f39cd82 159#endif