🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.4.1 / . / pack.h
blob: 3223f5a0380f735509424bbdbad64097948ef85b [file] [log] [blame]
Linus Torvaldsa733cb62005-06-28 21:21:02[diff] [blame]1#ifndef PACK_H
2#define PACK_H
3
Linus Torvalds19746322006-07-12 03:45:31[diff] [blame]4#include "object.h"
Junio C Hamanoc0ad4652011-10-28 18:40:48[diff] [blame]5#include "csum-file.h"
Linus Torvaldsa733cb62005-06-28 21:21:02[diff] [blame]6
7/*
8 * Packed object header
9 */
10#define PACK_SIGNATURE 0x5041434b /* "PACK" */
Junio C Hamano29f049a2006-10-15 06:37:41[diff] [blame]11#define PACK_VERSION 2
Nicolas Pitred60fc1c2006-02-09 22:50:04[diff] [blame]12#define pack_version_ok(v) ((v) == htonl(2) || (v) == htonl(3))
Linus Torvaldsa733cb62005-06-28 21:21:02[diff] [blame]13struct pack_header {
Simon 'corecode' Schubertbb791032007-01-17 08:07:23[diff] [blame]14 uint32_t hdr_signature;
15 uint32_t hdr_version;
16 uint32_t hdr_entries;
Linus Torvaldsa733cb62005-06-28 21:21:02[diff] [blame]17};
18
Shawn O. Pearcedf1b0592007-01-18 01:43:57[diff] [blame]19/*
Nicolas Pitre42873072007-03-16 20:42:50[diff] [blame]20 * The first four bytes of index formats later than version 1 should
21 * start with this signature, as all older git binaries would find this
22 * value illegal and abort reading the file.
Shawn O. Pearcedf1b0592007-01-18 01:43:57[diff] [blame]23 *
24 * This is the case because the number of objects in a packfile
25 * cannot exceed 1,431,660,000 as every object would need at least
Nicolas Pitre42873072007-03-16 20:42:50[diff] [blame]26 * 3 bytes of data and the overall packfile cannot exceed 4 GiB with
27 * version 1 of the index file due to the offsets limited to 32 bits.
28 * Clearly the signature exceeds this maximum.
Shawn O. Pearcedf1b0592007-01-18 01:43:57[diff] [blame]29 *
30 * Very old git binaries will also compare the first 4 bytes to the
31 * next 4 bytes in the index and abort with a "non-monotonic index"
32 * error if the second 4 byte word is smaller than the first 4
33 * byte word. This would be true in the proposed future index
34 * format as idx_signature would be greater than idx_version.
35 */
36#define PACK_IDX_SIGNATURE 0xff744f63 /* "\377tOc" */
37
Junio C Hamanoebcfb372011-02-25 23:43:25[diff] [blame]38struct pack_idx_option {
Junio C Hamanoe337a042011-02-03 01:29:01[diff] [blame]39 unsigned flags;
40 /* flag bits */
Junio C Hamano68be2fe2011-11-17 06:04:13[diff] [blame]41#define WRITE_IDX_VERIFY 01 /* verify only, do not write the idx file */
42#define WRITE_IDX_STRICT 02
Junio C Hamanoe337a042011-02-03 01:29:01[diff] [blame]43
Junio C Hamanoebcfb372011-02-25 23:43:25[diff] [blame]44 uint32_t version;
45 uint32_t off32_limit;
Junio C Hamano3c9fc072011-02-26 00:55:26[diff] [blame]46
47 /*
48 * List of offsets that would fit within off32_limit but
49 * need to be written out as 64-bit entity for byte-for-byte
50 * verification.
51 */
52 int anomaly_alloc, anomaly_nr;
53 uint32_t *anomaly;
Junio C Hamanoebcfb372011-02-25 23:43:25[diff] [blame]54};
55
56extern void reset_pack_idx_option(struct pack_idx_option *);
Geert Boschaa7e44b2007-06-01 19:18:05[diff] [blame]57
Nicolas Pitre42873072007-03-16 20:42:50[diff] [blame]58/*
59 * Packed object index header
60 */
61struct pack_idx_header {
62 uint32_t idx_signature;
63 uint32_t idx_version;
64};
65
Geert Boschaa7e44b2007-06-01 19:18:05[diff] [blame]66/*
67 * Common part of object structure used for write_idx_file
68 */
69struct pack_idx_entry {
70 unsigned char sha1[20];
71 uint32_t crc32;
72 off_t offset;
73};
74
Nguyễn Thái Ngọc Duyc9486eb2011-11-07 02:59:25[diff] [blame]75
Nguyễn Thái Ngọc Duy1e49f222011-11-07 02:59:26[diff] [blame]76struct progress;
Nguyễn Thái Ngọc Duyc9486eb2011-11-07 02:59:25[diff] [blame]77typedef int (*verify_fn)(const unsigned char*, enum object_type, unsigned long, void*, int*);
78
Jeff King1190a1a2013-12-05 20:28:07[diff] [blame]79extern 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);
Nicolas Pitrec41a4a92008-06-25 03:19:02[diff] [blame]80extern int check_pack_crc(struct packed_git *p, struct pack_window **w_curs, off_t offset, off_t len, unsigned int nr);
Shawn O. Pearce9b0aa722010-04-19 14:23:07[diff] [blame]81extern int verify_pack_index(struct packed_git *);
Nguyễn Thái Ngọc Duy1e49f222011-11-07 02:59:26[diff] [blame]82extern int verify_pack(struct packed_git *, verify_fn fn, struct progress *, uint32_t);
Junio C Hamanoc0ad4652011-10-28 18:40:48[diff] [blame]83extern off_t write_pack_header(struct sha1file *f, uint32_t);
Nicolas Pitreabeb40e2008-08-29 20:07:59[diff] [blame]84extern void fixup_pack_header_footer(int, unsigned char *, const char *, uint32_t, unsigned char *, off_t);
Shawn O. Pearce106764e2007-09-14 07:31:16[diff] [blame]85extern char *index_pack_lockfile(int fd);
Nicolas Pitref965c522010-02-23 20:02:37[diff] [blame]86extern int encode_in_pack_object_header(enum object_type, uintmax_t, unsigned char *);
Junio C Hamanoa69e5422007-01-23 05:55:18[diff] [blame]87
88#define PH_ERROR_EOF (-1)
89#define PH_ERROR_PACK_SIGNATURE (-2)
90#define PH_ERROR_PROTOCOL (-3)
91extern int read_pack_header(int fd, struct pack_header *);
Junio C Hamanocdf9db32011-10-28 18:52:14[diff] [blame]92
93extern struct sha1file *create_tmp_packfile(char **pack_tmp_name);
Sun He58892712014-03-03 09:24:29[diff] [blame]94extern void finish_tmp_packfile(struct strbuf *name_buffer, const char *pack_tmp_name, struct pack_idx_entry **written_list, uint32_t nr_written, struct pack_idx_option *pack_idx_opts, unsigned char sha1[]);
Junio C Hamanocdf9db32011-10-28 18:52:14[diff] [blame]95
Linus Torvaldsa733cb62005-06-28 21:21:02[diff] [blame]96#endif