]>
Commit | Line | Data |
---|---|---|
a733cb60 LT |
1 | #ifndef PACK_H |
2 | #define PACK_H | |
3 | ||
1974632c | 4 | #include "object.h" |
c0ad4657 | 5 | #include "csum-file.h" |
a733cb60 | 6 | |
94e10825 NTND |
7 | struct repository; |
8 | ||
a733cb60 LT |
9 | /* |
10 | * Packed object header | |
11 | */ | |
12 | #define PACK_SIGNATURE 0x5041434b /* "PACK" */ | |
29f049a0 | 13 | #define PACK_VERSION 2 |
d60fc1c8 | 14 | #define pack_version_ok(v) ((v) == htonl(2) || (v) == htonl(3)) |
a733cb60 | 15 | struct pack_header { |
bb791031 SS |
16 | uint32_t hdr_signature; |
17 | uint32_t hdr_version; | |
18 | uint32_t hdr_entries; | |
a733cb60 LT |
19 | }; |
20 | ||
df1b059d | 21 | /* |
42873078 NP |
22 | * The first four bytes of index formats later than version 1 should |
23 | * start with this signature, as all older git binaries would find this | |
24 | * value illegal and abort reading the file. | |
df1b059d SP |
25 | * |
26 | * This is the case because the number of objects in a packfile | |
27 | * cannot exceed 1,431,660,000 as every object would need at least | |
42873078 NP |
28 | * 3 bytes of data and the overall packfile cannot exceed 4 GiB with |
29 | * version 1 of the index file due to the offsets limited to 32 bits. | |
30 | * Clearly the signature exceeds this maximum. | |
df1b059d SP |
31 | * |
32 | * Very old git binaries will also compare the first 4 bytes to the | |
33 | * next 4 bytes in the index and abort with a "non-monotonic index" | |
34 | * error if the second 4 byte word is smaller than the first 4 | |
35 | * byte word. This would be true in the proposed future index | |
36 | * format as idx_signature would be greater than idx_version. | |
37 | */ | |
38 | #define PACK_IDX_SIGNATURE 0xff744f63 /* "\377tOc" */ | |
39 | ||
ebcfb379 | 40 | struct pack_idx_option { |
e337a04d JH |
41 | unsigned flags; |
42 | /* flag bits */ | |
68be2fea JH |
43 | #define WRITE_IDX_VERIFY 01 /* verify only, do not write the idx file */ |
44 | #define WRITE_IDX_STRICT 02 | |
8ef50d99 TB |
45 | #define WRITE_REV 04 |
46 | #define WRITE_REV_VERIFY 010 | |
5dfaf49a | 47 | #define WRITE_MTIMES 020 |
e337a04d | 48 | |
ebcfb379 JH |
49 | uint32_t version; |
50 | uint32_t off32_limit; | |
3c9fc074 JH |
51 | |
52 | /* | |
53 | * List of offsets that would fit within off32_limit but | |
54 | * need to be written out as 64-bit entity for byte-for-byte | |
55 | * verification. | |
56 | */ | |
57 | int anomaly_alloc, anomaly_nr; | |
58 | uint32_t *anomaly; | |
ebcfb379 JH |
59 | }; |
60 | ||
55454427 | 61 | void reset_pack_idx_option(struct pack_idx_option *); |
aa7e44bf | 62 | |
42873078 NP |
63 | /* |
64 | * Packed object index header | |
65 | */ | |
66 | struct pack_idx_header { | |
67 | uint32_t idx_signature; | |
68 | uint32_t idx_version; | |
69 | }; | |
70 | ||
aa7e44bf GB |
71 | /* |
72 | * Common part of object structure used for write_idx_file | |
73 | */ | |
74 | struct pack_idx_entry { | |
e6a492b7 | 75 | struct object_id oid; |
aa7e44bf GB |
76 | uint32_t crc32; |
77 | off_t offset; | |
78 | }; | |
79 | ||
c9486eb0 | 80 | |
1e49f22f | 81 | struct progress; |
ec9d2249 | 82 | /* Note, the data argument could be NULL if object type is blob */ |
9fd75046 | 83 | typedef int (*verify_fn)(const struct object_id *, enum object_type, unsigned long, void*, int*); |
c9486eb0 | 84 | |
55454427 DL |
85 | const char *write_idx_file(const char *index_name, struct pack_idx_entry **objects, int nr_objects, const struct pack_idx_option *, const unsigned char *sha1); |
86 | int check_pack_crc(struct packed_git *p, struct pack_window **w_curs, off_t offset, off_t len, unsigned int nr); | |
87 | int verify_pack_index(struct packed_git *); | |
88 | int verify_pack(struct repository *, struct packed_git *, verify_fn fn, struct progress *, uint32_t); | |
89 | off_t write_pack_header(struct hashfile *f, uint32_t); | |
90 | void fixup_pack_header_footer(int, unsigned char *, const char *, uint32_t, unsigned char *, off_t); | |
5476e1ef | 91 | char *index_pack_lockfile(int fd, int *is_well_formed); |
2c5e2865 | 92 | |
33add2ad CC |
93 | struct ref; |
94 | ||
95 | void write_promisor_file(const char *promisor_name, struct ref **sought, int nr_sought); | |
96 | ||
8ef50d99 | 97 | const char *write_rev_file(const char *rev_name, struct pack_idx_entry **objects, uint32_t nr_objects, const unsigned char *hash, unsigned flags); |
a587b5a7 | 98 | const char *write_rev_file_order(const char *rev_name, uint32_t *pack_order, uint32_t nr_objects, const unsigned char *hash, unsigned flags); |
8ef50d99 | 99 | |
2c5e2865 JK |
100 | /* |
101 | * The "hdr" output buffer should be at least this big, which will handle sizes | |
102 | * up to 2^67. | |
103 | */ | |
104 | #define MAX_PACK_OBJECT_HEADER 10 | |
55454427 | 105 | int encode_in_pack_object_header(unsigned char *hdr, int hdr_len, |
ad6dad09 | 106 | enum object_type, uintmax_t); |
a69e5429 JH |
107 | |
108 | #define PH_ERROR_EOF (-1) | |
109 | #define PH_ERROR_PACK_SIGNATURE (-2) | |
110 | #define PH_ERROR_PROTOCOL (-3) | |
55454427 | 111 | int read_pack_header(int fd, struct pack_header *); |
cdf9db3c | 112 | |
1c573cdd TB |
113 | struct packing_data; |
114 | ||
55454427 | 115 | struct hashfile *create_tmp_packfile(char **pack_tmp_name); |
2ec02dd5 | 116 | void stage_tmp_packfiles(struct strbuf *name_buffer, |
0c41a887 ÆAB |
117 | const char *pack_tmp_name, |
118 | struct pack_idx_entry **written_list, | |
119 | uint32_t nr_written, | |
1c573cdd | 120 | struct packing_data *to_pack, |
0c41a887 | 121 | struct pack_idx_option *pack_idx_opts, |
2ec02dd5 ÆAB |
122 | unsigned char hash[], |
123 | char **idx_tmp_name); | |
124 | void rename_tmp_packfile_idx(struct strbuf *basename, | |
125 | char **idx_tmp_name); | |
cdf9db3c | 126 | |
a733cb60 | 127 | #endif |