blob: d4d412ccbb403f1374d41a00791eec3c16ba64ef [file] [log] [blame]
Linus Torvaldsa733cb62005-06-28 14:21:02 -07001#ifndef PACK_H
2#define PACK_H
3
Linus Torvalds19746322006-07-11 20:45:31 -07004#include "object.h"
Linus Torvaldsa733cb62005-06-28 14:21:02 -07005
6/*
7 * Packed object header
8 */
9#define PACK_SIGNATURE 0x5041434b /* "PACK" */
Junio C Hamano29f049a2006-10-14 23:37:41 -070010#define PACK_VERSION 2
Nicolas Pitred60fc1c2006-02-09 17:50:04 -050011#define pack_version_ok(v) ((v) == htonl(2) || (v) == htonl(3))
Linus Torvaldsa733cb62005-06-28 14:21:02 -070012struct pack_header {
Simon 'corecode' Schubertbb791032007-01-17 09:07:23 +010013 uint32_t hdr_signature;
14 uint32_t hdr_version;
15 uint32_t hdr_entries;
Linus Torvaldsa733cb62005-06-28 14:21:02 -070016};
17
Shawn O. Pearcedf1b0592007-01-17 20:43:57 -050018/*
Nicolas Pitre42873072007-03-16 16:42:50 -040019 * The first four bytes of index formats later than version 1 should
20 * start with this signature, as all older git binaries would find this
21 * value illegal and abort reading the file.
Shawn O. Pearcedf1b0592007-01-17 20:43:57 -050022 *
23 * This is the case because the number of objects in a packfile
24 * cannot exceed 1,431,660,000 as every object would need at least
Nicolas Pitre42873072007-03-16 16:42:50 -040025 * 3 bytes of data and the overall packfile cannot exceed 4 GiB with
26 * version 1 of the index file due to the offsets limited to 32 bits.
27 * Clearly the signature exceeds this maximum.
Shawn O. Pearcedf1b0592007-01-17 20:43:57 -050028 *
29 * Very old git binaries will also compare the first 4 bytes to the
30 * next 4 bytes in the index and abort with a "non-monotonic index"
31 * error if the second 4 byte word is smaller than the first 4
32 * byte word. This would be true in the proposed future index
33 * format as idx_signature would be greater than idx_version.
34 */
35#define PACK_IDX_SIGNATURE 0xff744f63 /* "\377tOc" */
36
Nicolas Pitre42873072007-03-16 16:42:50 -040037/*
38 * Packed object index header
39 */
40struct pack_idx_header {
41 uint32_t idx_signature;
42 uint32_t idx_version;
43};
44
45
Junio C Hamanof3bf9222005-06-30 17:15:39 -070046extern int verify_pack(struct packed_git *, int);
Junio C Hamanoa69e5422007-01-22 21:55:18 -080047
48#define PH_ERROR_EOF (-1)
49#define PH_ERROR_PACK_SIGNATURE (-2)
50#define PH_ERROR_PROTOCOL (-3)
51extern int read_pack_header(int fd, struct pack_header *);
Linus Torvaldsa733cb62005-06-28 14:21:02 -070052#endif