1 /*
2  * Copyright (c) 2018, 2019, 2020 Stefan Sperling <stsp@openbsd.org>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 struct got_object {
18 	int type;
19 
20 	int flags;
21 #define GOT_OBJ_FLAG_PACKED		0x01
22 #define GOT_OBJ_FLAG_DELTIFIED		0x02
23 
24 	size_t hdrlen;
25 	size_t size;
26 	struct got_object_id id;
27 
28 	int pack_idx;		/* if packed */
29 	off_t pack_offset;	/* if packed */
30 	struct got_delta_chain deltas; /* if deltified */
31 	int refcnt;		/* > 0 if open and/or cached */
32 };
33 
34 struct got_raw_object {
35 	FILE *f;		/* NULL if data buffer is being used */
36 	int fd;			/* -1 unless data buffer is memory-mapped */
37 	uint8_t *data;
38 	off_t size;
39 	size_t hdrlen;
40 	int refcnt;		/* > 0 if open and/or cached */
41 };
42 
43 struct got_commit_object {
44 	struct got_object_id *tree_id;
45 	unsigned int nparents;
46 	struct got_object_id_queue parent_ids;
47 	char *author;
48 	time_t author_time;	/* UTC */
49 	time_t author_gmtoff;
50 	char *committer;
51 	time_t committer_time;	/* UTC */
52 	time_t committer_gmtoff;
53 	char *logmsg;
54 	int refcnt;		/* > 0 if open and/or cached */
55 
56 	int flags;
57 #define GOT_COMMIT_FLAG_PACKED		0x01
58 };
59 
60 struct got_tree_entry {
61 	mode_t mode;
62 	char name[NAME_MAX + 1 /* NUL */];
63 	struct got_object_id id;
64 	int idx;
65 };
66 
67 struct got_tree_object {
68 	int nentries;
69 	struct got_tree_entry *entries;
70 	int refcnt;
71 };
72 
73 struct got_blob_object {
74 	FILE *f;
75 	uint8_t *data;
76 	size_t hdrlen;
77 	size_t blocksize;
78 	uint8_t *read_buf;
79 	struct got_object_id id;
80 };
81 
82 struct got_tag_object {
83 	struct got_object_id id;
84 	int obj_type;
85 	char *tag;
86 	time_t tagger_time;
87 	time_t tagger_gmtoff;
88 	char *tagger;
89 	char *tagmsg;
90 	int refcnt;		/* > 0 if open and/or cached */
91 };
92 
93 struct got_object_id *got_object_get_id(struct got_object *);
94 const struct got_error *got_object_get_id_str(char **, struct got_object *);
95 const struct got_error *got_object_get_path(char **, struct got_object_id *,
96     struct got_repository *);
97 const struct got_error *got_object_open_loose_fd(int *, struct got_object_id *,
98     struct got_repository *);
99 const struct got_error *got_object_open_packed(struct got_object **,
100     struct got_object_id *, struct got_repository *);
101 struct got_pack;
102 struct got_packidx;
103 const struct got_error *got_object_open_from_packfile(struct got_object **,
104     struct got_object_id *, struct got_pack *, struct got_packidx *, int,
105     struct got_repository *);
106 const struct got_error *got_object_read_raw_delta(uint64_t *, uint64_t *,
107     off_t *, off_t *, off_t *, off_t *, struct got_object_id **, int,
108     struct got_packidx *, int, struct got_object_id *, struct got_repository *);
109 const struct got_error *got_object_prepare_delta_reuse(struct got_pack **,
110     struct got_packidx *, int, struct got_repository *);
111 const struct got_error *got_object_read_header_privsep(struct got_object **,
112     struct got_object_id *, struct got_repository *, int);
113 const struct got_error *got_object_open(struct got_object **,
114     struct got_repository *, struct got_object_id *);
115 const struct got_error *got_object_raw_open(struct got_raw_object **, int *,
116     struct got_repository *, struct got_object_id *);
117 const struct got_error *got_object_raw_close(struct got_raw_object *);
118 const struct got_error *got_object_open_by_id_str(struct got_object **,
119     struct got_repository *, const char *);
120 void got_object_close(struct got_object *);
121 const struct got_error *got_object_commit_open(struct got_commit_object **,
122     struct got_repository *, struct got_object *);
123 const struct got_error *got_object_tree_open(struct got_tree_object **,
124     struct got_repository *, struct got_object *);
125 const struct got_error *got_object_blob_open(struct got_blob_object **,
126     struct got_repository *, struct got_object *, size_t, int);
127 char *got_object_blob_id_str(struct got_blob_object*, char *, size_t);
128 const struct got_error *got_object_tag_open(struct got_tag_object **,
129     struct got_repository *, struct got_object *);
130 const struct got_error *got_object_tree_entry_dup(struct got_tree_entry **,
131     struct got_tree_entry *);
132 
133 const struct got_error *got_traverse_packed_commits(
134     struct got_object_id_queue *, struct got_object_id *, const char *,
135     struct got_repository *);
136 
137 typedef const struct got_error *(*got_object_enumerate_commit_cb)(void *,
138     time_t, struct got_object_id *, struct got_repository *);
139 typedef const struct got_error *(*got_object_enumerate_tree_cb)(void *,
140     struct got_tree_object *, time_t, struct got_object_id *, const char *,
141     struct got_repository *);
142 
143 const struct got_error *got_object_enumerate(int *,
144     got_object_enumerate_commit_cb, got_object_enumerate_tree_cb, void *,
145     struct got_object_id **, int, struct got_object_id **, int,
146     struct got_packidx *, struct got_repository *);