Blob


1 /*
2 * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3 * Copyright (c) 2019, Ori Bernstein <ori@openbsd.org>
4 *
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
18 /*
19 * All code runs under the same UID but sensitive code paths are
20 * run in a separate process with tighter pledge(2) promises.
21 * Data is communicated between processes via imsg_flush(3) and imsg_read(3).
22 * This behaviour is transparent to users of the library.
23 *
24 * We generally transmit data in imsg buffers, split across several messages
25 * if necessary. File descriptors are used in cases where this is impractical,
26 * such as when accessing pack files or when transferring large blobs.
27 *
28 * We exec(2) after a fork(2). Parts of our library functionality are
29 * accessible via separate executables in a libexec directory.
30 */
32 #define GOT_IMSG_FD_CHILD (STDERR_FILENO + 1)
34 #ifndef GOT_LIBEXECDIR
35 #define GOT_LIBEXECDIR /usr/libexec
36 #endif
38 /* Names of helper programs in libexec directory */
39 #define GOT_PROG_READ_OBJECT got-read-object
40 #define GOT_PROG_READ_TREE got-read-tree
41 #define GOT_PROG_READ_COMMIT got-read-commit
42 #define GOT_PROG_READ_BLOB got-read-blob
43 #define GOT_PROG_READ_TAG got-read-tag
44 #define GOT_PROG_READ_PACK got-read-pack
45 #define GOT_PROG_READ_GITCONFIG got-read-gitconfig
46 #define GOT_PROG_READ_GOTCONFIG got-read-gotconfig
47 #define GOT_PROG_READ_PATCH got-read-patch
48 #define GOT_PROG_FETCH_PACK got-fetch-pack
49 #define GOT_PROG_INDEX_PACK got-index-pack
50 #define GOT_PROG_SEND_PACK got-send-pack
52 #define GOT_STRINGIFY(x) #x
53 #define GOT_STRINGVAL(x) GOT_STRINGIFY(x)
55 /* Paths to helper programs in libexec directory */
56 #define GOT_PATH_PROG_READ_OBJECT \
57 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_OBJECT)
58 #define GOT_PATH_PROG_READ_TREE \
59 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TREE)
60 #define GOT_PATH_PROG_READ_COMMIT \
61 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_COMMIT)
62 #define GOT_PATH_PROG_READ_BLOB \
63 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_BLOB)
64 #define GOT_PATH_PROG_READ_TAG \
65 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_TAG)
66 #define GOT_PATH_PROG_READ_PACK \
67 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PACK)
68 #define GOT_PATH_PROG_READ_GITCONFIG \
69 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_GITCONFIG)
70 #define GOT_PATH_PROG_READ_GOTCONFIG \
71 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_GOTCONFIG)
72 #define GOT_PATH_PROG_READ_PATCH \
73 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_READ_PATCH)
74 #define GOT_PATH_PROG_FETCH_PACK \
75 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_FETCH_PACK)
76 #define GOT_PATH_PROG_SEND_PACK \
77 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_SEND_PACK)
78 #define GOT_PATH_PROG_INDEX_PACK \
79 GOT_STRINGVAL(GOT_LIBEXECDIR) "/" GOT_STRINGVAL(GOT_PROG_INDEX_PACK)
81 enum got_imsg_type {
82 /* An error occured while processing a request. */
83 GOT_IMSG_ERROR,
85 /* Stop the child process. */
86 GOT_IMSG_STOP,
88 /*
89 * Messages concerned with read access to objects in a repository.
90 * Object and pack files are opened by the main process, where
91 * data may be read as a byte string but without any interpretation.
92 * Decompression and parsing of object and pack files occurs in a
93 * separate process which runs under pledge("stdio recvfd").
94 * This sandboxes our own repository parsing code, as well as zlib.
95 */
96 GOT_IMSG_OBJECT_REQUEST,
97 GOT_IMSG_OBJECT,
98 GOT_IMSG_COMMIT_REQUEST,
99 GOT_IMSG_COMMIT,
100 GOT_IMSG_COMMIT_LOGMSG,
101 GOT_IMSG_TREE_REQUEST,
102 GOT_IMSG_TREE,
103 GOT_IMSG_TREE_ENTRIES,
104 GOT_IMSG_BLOB_REQUEST,
105 GOT_IMSG_BLOB_OUTFD,
106 GOT_IMSG_BLOB,
107 GOT_IMSG_TAG_REQUEST,
108 GOT_IMSG_TAG,
109 GOT_IMSG_TAG_TAGMSG,
111 /* Messages related to networking. */
112 GOT_IMSG_FETCH_REQUEST,
113 GOT_IMSG_FETCH_HAVE_REF,
114 GOT_IMSG_FETCH_WANTED_BRANCH,
115 GOT_IMSG_FETCH_WANTED_REF,
116 GOT_IMSG_FETCH_OUTFD,
117 GOT_IMSG_FETCH_SYMREFS,
118 GOT_IMSG_FETCH_REF,
119 GOT_IMSG_FETCH_SERVER_PROGRESS,
120 GOT_IMSG_FETCH_DOWNLOAD_PROGRESS,
121 GOT_IMSG_FETCH_DONE,
122 GOT_IMSG_IDXPACK_REQUEST,
123 GOT_IMSG_IDXPACK_OUTFD,
124 GOT_IMSG_IDXPACK_PROGRESS,
125 GOT_IMSG_IDXPACK_DONE,
126 GOT_IMSG_SEND_REQUEST,
127 GOT_IMSG_SEND_REF,
128 GOT_IMSG_SEND_REMOTE_REF,
129 GOT_IMSG_SEND_REF_STATUS,
130 GOT_IMSG_SEND_PACK_REQUEST,
131 GOT_IMSG_SEND_PACKFD,
132 GOT_IMSG_SEND_UPLOAD_PROGRESS,
133 GOT_IMSG_SEND_DONE,
135 /* Messages related to pack files. */
136 GOT_IMSG_PACKIDX,
137 GOT_IMSG_PACK,
138 GOT_IMSG_PACKED_OBJECT_REQUEST,
139 GOT_IMSG_COMMIT_TRAVERSAL_REQUEST,
140 GOT_IMSG_TRAVERSED_COMMITS,
141 GOT_IMSG_COMMIT_TRAVERSAL_DONE,
142 GOT_IMSG_OBJECT_ENUMERATION_REQUEST,
143 GOT_IMSG_ENUMERATED_COMMIT,
144 GOT_IMSG_ENUMERATED_TREE,
145 GOT_IMSG_TREE_ENUMERATION_DONE,
146 GOT_IMSG_OBJECT_ENUMERATION_DONE,
147 GOT_IMSG_OBJECT_ENUMERATION_INCOMPLETE,
149 /* Message sending file descriptor to a temporary file. */
150 GOT_IMSG_TMPFD,
152 /* Messages related to gitconfig files. */
153 GOT_IMSG_GITCONFIG_PARSE_REQUEST,
154 GOT_IMSG_GITCONFIG_REPOSITORY_FORMAT_VERSION_REQUEST,
155 GOT_IMSG_GITCONFIG_REPOSITORY_EXTENSIONS_REQUEST,
156 GOT_IMSG_GITCONFIG_AUTHOR_NAME_REQUEST,
157 GOT_IMSG_GITCONFIG_AUTHOR_EMAIL_REQUEST,
158 GOT_IMSG_GITCONFIG_REMOTES_REQUEST,
159 GOT_IMSG_GITCONFIG_INT_VAL,
160 GOT_IMSG_GITCONFIG_STR_VAL,
161 GOT_IMSG_GITCONFIG_REMOTES,
162 GOT_IMSG_GITCONFIG_REMOTE,
163 GOT_IMSG_GITCONFIG_OWNER_REQUEST,
164 GOT_IMSG_GITCONFIG_OWNER,
166 /* Messages related to gotconfig files. */
167 GOT_IMSG_GOTCONFIG_PARSE_REQUEST,
168 GOT_IMSG_GOTCONFIG_AUTHOR_REQUEST,
169 GOT_IMSG_GOTCONFIG_ALLOWEDSIGNERS_REQUEST,
170 GOT_IMSG_GOTCONFIG_REVOKEDSIGNERS_REQUEST,
171 GOT_IMSG_GOTCONFIG_SIGNERID_REQUEST,
172 GOT_IMSG_GOTCONFIG_REMOTES_REQUEST,
173 GOT_IMSG_GOTCONFIG_INT_VAL,
174 GOT_IMSG_GOTCONFIG_STR_VAL,
175 GOT_IMSG_GOTCONFIG_REMOTES,
176 GOT_IMSG_GOTCONFIG_REMOTE,
178 /* Raw object access. Uncompress object data but do not parse it. */
179 GOT_IMSG_RAW_OBJECT_REQUEST,
180 GOT_IMSG_RAW_OBJECT_OUTFD,
181 GOT_IMSG_PACKED_RAW_OBJECT_REQUEST,
182 GOT_IMSG_RAW_OBJECT,
184 /* Read raw delta data from pack files. */
185 GOT_IMSG_RAW_DELTA_OUTFD,
186 GOT_IMSG_RAW_DELTA_REQUEST,
187 GOT_IMSG_RAW_DELTA,
189 /* Re-use deltas found in a pack file. */
190 GOT_IMSG_DELTA_REUSE_REQUEST,
191 GOT_IMSG_REUSED_DELTAS,
192 GOT_IMSG_DELTA_REUSE_DONE,
194 /* Commit coloring in got-read-pack. */
195 GOT_IMSG_COMMIT_PAINTING_INIT,
196 GOT_IMSG_COMMIT_PAINTING_REQUEST,
197 GOT_IMSG_PAINTED_COMMITS,
198 GOT_IMSG_COMMIT_PAINTING_DONE,
200 /* Transfer a list of object IDs. */
201 GOT_IMSG_OBJ_ID_LIST,
202 GOT_IMSG_OBJ_ID_LIST_DONE,
204 /* Messages related to patch files. */
205 GOT_IMSG_PATCH_FILE,
206 GOT_IMSG_PATCH_HUNK,
207 GOT_IMSG_PATCH_DONE,
208 GOT_IMSG_PATCH_LINE,
209 GOT_IMSG_PATCH,
210 GOT_IMSG_PATCH_EOF,
211 };
213 /* Structure for GOT_IMSG_ERROR. */
214 struct got_imsg_error {
215 int code; /* an error code from got_error.h */
216 int errno_code; /* in case code equals GOT_ERR_ERRNO */
217 } __attribute__((__packed__));
219 /*
220 * Structure for GOT_IMSG_TREE_REQUEST and GOT_IMSG_OBJECT data.
221 */
222 struct got_imsg_object {
223 uint8_t id[SHA1_DIGEST_LENGTH];
225 /* These fields are the same as in struct got_object. */
226 int type;
227 int flags;
228 size_t hdrlen;
229 size_t size;
230 off_t pack_offset;
231 int pack_idx;
232 } __attribute__((__packed__));
234 /* Structure for GOT_IMSG_COMMIT data. */
235 struct got_imsg_commit_object {
236 uint8_t tree_id[SHA1_DIGEST_LENGTH];
237 size_t author_len;
238 time_t author_time;
239 time_t author_gmtoff;
240 size_t committer_len;
241 time_t committer_time;
242 time_t committer_gmtoff;
243 size_t logmsg_len;
244 int nparents;
246 /*
247 * Followed by author_len + committer_len data bytes
248 */
250 /* Followed by 'nparents' SHA1_DIGEST_LENGTH length strings */
252 /*
253 * Followed by 'logmsg_len' bytes of commit log message data in
254 * one or more GOT_IMSG_COMMIT_LOGMSG messages.
255 */
256 } __attribute__((__packed__));
258 struct got_imsg_tree_entry {
259 char id[SHA1_DIGEST_LENGTH];
260 mode_t mode;
261 size_t namelen;
262 /* Followed by namelen bytes of entry's name, not NUL-terminated. */
263 } __attribute__((__packed__));
265 /* Structure for GOT_IMSG_TREE_ENTRIES. */
266 struct got_imsg_tree_entries {
267 size_t nentries; /* Number of tree entries contained in this message. */
269 /* Followed by nentries * struct got_imsg_tree_entry */
270 };
272 /* Structure for GOT_IMSG_TREE_OBJECT_REPLY data. */
273 struct got_imsg_tree_object {
274 int nentries; /* This many tree entries follow. */
275 };
277 /* Structure for GOT_IMSG_BLOB. */
278 struct got_imsg_blob {
279 size_t size;
280 size_t hdrlen;
282 /*
283 * If size <= GOT_PRIVSEP_INLINE_BLOB_DATA_MAX, blob data follows
284 * in the imsg buffer. Otherwise, blob data has been written to a
285 * file descriptor passed via the GOT_IMSG_BLOB_OUTFD imsg.
286 */
287 #define GOT_PRIVSEP_INLINE_BLOB_DATA_MAX \
288 (MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_blob))
289 };
291 /* Structure for GOT_IMSG_RAW_OBJECT. */
292 struct got_imsg_raw_obj {
293 off_t size;
294 size_t hdrlen;
296 /*
297 * If size <= GOT_PRIVSEP_INLINE_OBJECT_DATA_MAX, object data follows
298 * in the imsg buffer. Otherwise, object data has been written to a
299 * file descriptor passed via the GOT_IMSG_RAW_OBJECT_OUTFD imsg.
300 */
301 #define GOT_PRIVSEP_INLINE_OBJECT_DATA_MAX \
302 (MAX_IMSGSIZE - IMSG_HEADER_SIZE - sizeof(struct got_imsg_raw_obj))
303 };
305 /* Structure for GOT_IMSG_RAW_DELTA. */
306 struct got_imsg_raw_delta {
307 uint8_t base_id[SHA1_DIGEST_LENGTH];
308 uint64_t base_size;
309 uint64_t result_size;
310 off_t delta_size;
311 off_t delta_compressed_size;
312 off_t delta_offset;
313 off_t delta_out_offset;
315 /*
316 * Delta data has been written at delta_out_offset to the file
317 * descriptor passed via the GOT_IMSG_RAW_DELTA_OUTFD imsg.
318 */
319 };
321 /* Structures for GOT_IMSG_REUSED_DELTAS. */
322 struct got_imsg_reused_delta {
323 struct got_object_id id;
324 struct got_object_id base_id;
325 uint64_t base_size;
326 uint64_t result_size;
327 off_t delta_size;
328 off_t delta_compressed_size;
329 off_t delta_offset;
330 off_t delta_out_offset;
332 /*
333 * Delta data has been written at delta_out_offset to the file
334 * descriptor passed via the GOT_IMSG_RAW_DELTA_OUTFD imsg.
335 */
336 };
337 struct got_imsg_reused_deltas {
338 size_t ndeltas;
340 /*
341 * Followed by ndeltas * struct got_imsg_reused_delta.
342 */
344 #define GOT_IMSG_REUSED_DELTAS_MAX_NDELTAS \
345 ((MAX_IMSGSIZE - IMSG_HEADER_SIZE - \
346 sizeof(struct got_imsg_reused_deltas)) \
347 / sizeof(struct got_imsg_reused_delta))
348 };
350 /* Structure for GOT_IMSG_COMMIT_PAINTING_REQUEST. */
351 struct got_imsg_commit_painting_request {
352 uint8_t id[SHA1_DIGEST_LENGTH];
353 int idx;
354 int color;
355 } __attribute__((__packed__));
357 /* Structure for GOT_IMSG_PAINTED_COMMITS. */
358 struct got_imsg_painted_commit {
359 uint8_t id[SHA1_DIGEST_LENGTH];
360 intptr_t color;
361 } __attribute__((__packed__));
363 struct got_imsg_painted_commits {
364 int ncommits;
365 int present_in_pack;
366 /*
367 * Followed by ncommits * struct got_imsg_painted_commit.
368 */
369 } __attribute__((__packed__));
371 /* Structure for GOT_IMSG_TAG data. */
372 struct got_imsg_tag_object {
373 uint8_t id[SHA1_DIGEST_LENGTH];
374 int obj_type;
375 size_t tag_len;
376 size_t tagger_len;
377 time_t tagger_time;
378 time_t tagger_gmtoff;
379 size_t tagmsg_len;
381 /*
382 * Followed by tag_len + tagger_len data bytes
383 */
385 /*
386 * Followed by 'tagmsg_len' bytes of tag message data in
387 * one or more GOT_IMSG_TAG_TAGMSG messages.
388 */
389 } __attribute__((__packed__));
391 /* Structure for GOT_IMSG_FETCH_HAVE_REF data. */
392 struct got_imsg_fetch_have_ref {
393 uint8_t id[SHA1_DIGEST_LENGTH];
394 size_t name_len;
395 /* Followed by name_len data bytes. */
396 } __attribute__((__packed__));
398 /* Structure for GOT_IMSG_FETCH_WANTED_BRANCH data. */
399 struct got_imsg_fetch_wanted_branch {
400 size_t name_len;
401 /* Followed by name_len data bytes. */
402 } __attribute__((__packed__));
404 /* Structure for GOT_IMSG_FETCH_WANTED_REF data. */
405 struct got_imsg_fetch_wanted_ref {
406 size_t name_len;
407 /* Followed by name_len data bytes. */
408 } __attribute__((__packed__));
410 /* Structure for GOT_IMSG_FETCH_REQUEST data. */
411 struct got_imsg_fetch_request {
412 int fetch_all_branches;
413 int list_refs_only;
414 int verbosity;
415 size_t n_have_refs;
416 size_t n_wanted_branches;
417 size_t n_wanted_refs;
418 /* Followed by n_have_refs GOT_IMSG_FETCH_HAVE_REF messages. */
419 /* Followed by n_wanted_branches times GOT_IMSG_FETCH_WANTED_BRANCH. */
420 /* Followed by n_wanted_refs times GOT_IMSG_FETCH_WANTED_REF. */
421 } __attribute__((__packed__));
423 /* Structures for GOT_IMSG_FETCH_SYMREFS data. */
424 struct got_imsg_fetch_symref {
425 size_t name_len;
426 size_t target_len;
428 /*
429 * Followed by name_len + target_len data bytes.
430 */
431 } __attribute__((__packed__));
433 struct got_imsg_fetch_symrefs {
434 size_t nsymrefs;
436 /* Followed by nsymrefs times of got_imsg_fetch_symref data. */
437 } __attribute__((__packed__));
439 /* Structure for GOT_IMSG_FETCH_REF data. */
440 struct got_imsg_fetch_ref {
441 /* Describes a reference which will be fetched. */
442 uint8_t refid[SHA1_DIGEST_LENGTH];
443 /* Followed by reference name in remaining data of imsg buffer. */
444 };
446 /* Structure for GOT_IMSG_FETCH_DOWNLOAD_PROGRESS data. */
447 struct got_imsg_fetch_download_progress {
448 /* Number of packfile data bytes downloaded so far. */
449 off_t packfile_bytes;
450 };
452 /* Structure for GOT_IMSG_SEND_REQUEST data. */
453 struct got_imsg_send_request {
454 int verbosity;
455 size_t nrefs;
456 /* Followed by nrefs GOT_IMSG_SEND_REF messages. */
457 } __attribute__((__packed__));
459 /* Structure for GOT_IMSG_SEND_UPLOAD_PROGRESS data. */
460 struct got_imsg_send_upload_progress {
461 /* Number of packfile data bytes uploaded so far. */
462 off_t packfile_bytes;
463 };
465 /* Structure for GOT_IMSG_SEND_REF data. */
466 struct got_imsg_send_ref {
467 uint8_t id[SHA1_DIGEST_LENGTH];
468 int delete;
469 size_t name_len;
470 /* Followed by name_len data bytes. */
471 } __attribute__((__packed__));
473 /* Structure for GOT_IMSG_SEND_REMOTE_REF data. */
474 struct got_imsg_send_remote_ref {
475 uint8_t id[SHA1_DIGEST_LENGTH];
476 size_t name_len;
477 /* Followed by name_len data bytes. */
478 } __attribute__((__packed__));
480 /* Structure for GOT_IMSG_SEND_REF_STATUS data. */
481 struct got_imsg_send_ref_status {
482 int success;
483 size_t name_len;
484 /* Followed by name_len data bytes. */
485 } __attribute__((__packed__));
487 /* Structure for GOT_IMSG_IDXPACK_REQUEST data. */
488 struct got_imsg_index_pack_request {
489 uint8_t pack_hash[SHA1_DIGEST_LENGTH];
490 } __attribute__((__packed__));
492 /* Structure for GOT_IMSG_IDXPACK_PROGRESS data. */
493 struct got_imsg_index_pack_progress {
494 /* Total number of objects in pack file. */
495 int nobj_total;
497 /* Number of objects indexed so far. */
498 int nobj_indexed;
500 /* Number of non-deltified objects in pack file. */
501 int nobj_loose;
503 /* Number of deltified objects resolved so far. */
504 int nobj_resolved;
505 };
507 /* Structure for GOT_IMSG_PACKIDX. */
508 struct got_imsg_packidx {
509 size_t len;
510 off_t packfile_size;
511 /* Additionally, a file desciptor is passed via imsg. */
512 };
514 /* Structure for GOT_IMSG_PACK. */
515 struct got_imsg_pack {
516 char path_packfile[PATH_MAX];
517 off_t filesize;
518 /* Additionally, a file desciptor is passed via imsg. */
519 } __attribute__((__packed__));
521 /*
522 * Structure for GOT_IMSG_OBJECT_REQUEST, GOT_IMSG_BLOB_REQUEST,
523 * GOT_IMSG_TREE_REQUEST, GOT_IMSG_COMMIT_REQUEST, and
524 * GOT_IMSG_TAG_REQUEST data.
525 */
526 struct got_object_id;
528 /*
529 * Structure for GOT_IMSG_PACKED_OBJECT_REQUEST and
530 * GOT_IMSG_PACKED_RAW_OBJECT_REQUEST data.
531 */
532 struct got_imsg_packed_object {
533 uint8_t id[SHA1_DIGEST_LENGTH];
534 int idx;
535 } __attribute__((__packed__));
537 /*
538 * Structure for GOT_IMSG_DELTA data.
539 */
540 struct got_imsg_delta {
541 /* These fields are the same as in struct got_delta. */
542 off_t offset;
543 size_t tslen;
544 int type;
545 size_t size;
546 off_t data_offset;
547 };
549 /*
550 * Structure for GOT_IMSG_RAW_DELTA_REQUEST data.
551 */
552 struct got_imsg_raw_delta_request {
553 uint8_t id[SHA1_DIGEST_LENGTH];
554 int idx;
555 };
557 /*
558 * Structure for GOT_IMSG_OBJ_ID_LIST data.
559 * Multiple such messages may be sent back-to-back, where each message
560 * contains a chunk of IDs. The entire list must be terminated with a
561 * GOT_IMSG_OBJ_ID_LIST_DONE message.
562 */
563 struct got_imsg_object_idlist {
564 size_t nids;
566 /*
567 * Followed by nids * struct got_object_id.
568 */
570 #define GOT_IMSG_OBJ_ID_LIST_MAX_NIDS \
571 ((MAX_IMSGSIZE - IMSG_HEADER_SIZE - \
572 sizeof(struct got_imsg_object_idlist)) / sizeof(struct got_object_id))
573 };
575 /* Structure for GOT_IMSG_COMMIT_TRAVERSAL_REQUEST */
576 struct got_imsg_commit_traversal_request {
577 uint8_t id[SHA1_DIGEST_LENGTH];
578 int idx;
579 size_t path_len;
580 /* Followed by path_len bytes of path data */
581 } __attribute__((__packed__));
583 /* Structure for GOT_IMSG_TRAVERSED_COMMITS */
584 struct got_imsg_traversed_commits {
585 size_t ncommits;
586 /* Followed by ncommit IDs of SHA1_DIGEST_LENGTH each */
587 } __attribute__((__packed__));
589 /* Structure for GOT_IMSG_ENUMERATED_COMMIT */
590 struct got_imsg_enumerated_commit {
591 uint8_t id[SHA1_DIGEST_LENGTH];
592 time_t mtime;
593 } __attribute__((__packed__));
595 /* Structure for GOT_IMSG_ENUMERATED_TREE */
596 struct got_imsg_enumerated_tree {
597 uint8_t id[SHA1_DIGEST_LENGTH]; /* tree ID */
598 int nentries; /* number of tree entries */
600 /* Followed by tree's path in remaining data of imsg buffer. */
602 /* Followed by nentries * GOT_IMSG_TREE_ENTRY messages. */
603 } __attribute__((__packed__));
605 /*
606 * Structure for GOT_IMSG_GOTCONFIG_REMOTE and
607 * GOT_IMSG_GOTCONFIG_REMOTE data.
608 */
609 struct got_imsg_remote {
610 size_t name_len;
611 size_t fetch_url_len;
612 size_t send_url_len;
613 int mirror_references;
614 int fetch_all_branches;
615 int nfetch_branches;
616 int nsend_branches;
617 int nfetch_refs;
619 /* Followed by name_len data bytes. */
620 /* Followed by fetch_url_len + send_url_len data bytes. */
621 /* Followed by nfetch_branches GOT_IMSG_GITCONFIG_STR_VAL messages. */
622 /* Followed by nsend_branches GOT_IMSG_GITCONFIG_STR_VAL messages. */
623 /* Followed by nfetch_refs GOT_IMSG_GITCONFIG_STR_VAL messages. */
624 } __attribute__((__packed__));
626 /*
627 * Structure for GOT_IMSG_GITCONFIG_REMOTES data.
628 */
629 struct got_imsg_remotes {
630 int nremotes; /* This many GOT_IMSG_GITCONFIG_REMOTE messages follow. */
631 };
633 /*
634 * Structure for GOT_IMSG_PATCH data.
635 */
636 struct got_imsg_patch {
637 int git;
638 int xbit;
639 char old[PATH_MAX];
640 char new[PATH_MAX];
641 char cid[41];
642 char blob[41];
643 };
645 /*
646 * Structure for GOT_IMSG_PATCH_HUNK data.
647 */
648 struct got_imsg_patch_hunk {
649 int oldfrom;
650 int oldlines;
651 int newfrom;
652 int newlines;
653 };
655 struct got_remote_repo;
656 struct got_pack;
657 struct got_packidx;
658 struct got_pathlist_head;
660 const struct got_error *got_send_ack(pid_t);
661 const struct got_error *got_privsep_wait_for_child(pid_t);
662 const struct got_error *got_privsep_flush_imsg(struct imsgbuf *);
663 const struct got_error *got_privsep_send_stop(int);
664 const struct got_error *got_privsep_recv_imsg(struct imsg *, struct imsgbuf *,
665 size_t);
666 void got_privsep_send_error(struct imsgbuf *, const struct got_error *);
667 const struct got_error *got_privsep_send_ack(struct imsgbuf *);
668 const struct got_error *got_privsep_wait_ack(struct imsgbuf *);
669 const struct got_error *got_privsep_send_obj_req(struct imsgbuf *, int,
670 struct got_object_id *);
671 const struct got_error *got_privsep_send_raw_obj_req(struct imsgbuf *, int,
672 struct got_object_id *);
673 const struct got_error *got_privsep_send_raw_obj_outfd(struct imsgbuf *, int);
674 const struct got_error *got_privsep_send_commit_req(struct imsgbuf *, int,
675 struct got_object_id *, int);
676 const struct got_error *got_privsep_send_tree_req(struct imsgbuf *, int,
677 struct got_object_id *, int);
678 const struct got_error *got_privsep_send_tag_req(struct imsgbuf *, int,
679 struct got_object_id *, int);
680 const struct got_error *got_privsep_send_blob_req(struct imsgbuf *, int,
681 struct got_object_id *, int);
682 const struct got_error *got_privsep_send_blob_outfd(struct imsgbuf *, int);
683 const struct got_error *got_privsep_send_tmpfd(struct imsgbuf *, int);
684 const struct got_error *got_privsep_send_obj(struct imsgbuf *,
685 struct got_object *);
686 const struct got_error *got_privsep_send_index_pack_req(struct imsgbuf *,
687 uint8_t *, int);
688 const struct got_error *got_privsep_send_index_pack_outfd(struct imsgbuf *,
689 int);
690 const struct got_error *got_privsep_recv_index_progress(int *, int *, int *,
691 int *, int *, struct imsgbuf *ibuf);
692 const struct got_error *got_privsep_send_fetch_req(struct imsgbuf *, int,
693 struct got_pathlist_head *, int, struct got_pathlist_head *,
694 struct got_pathlist_head *, int, int);
695 const struct got_error *got_privsep_send_fetch_outfd(struct imsgbuf *, int);
696 const struct got_error *got_privsep_recv_fetch_progress(int *,
697 struct got_object_id **, char **, struct got_pathlist_head *, char **,
698 off_t *, uint8_t *, struct imsgbuf *);
699 const struct got_error *got_privsep_send_send_req(struct imsgbuf *, int,
700 struct got_pathlist_head *, struct got_pathlist_head *, int);
701 const struct got_error *got_privsep_recv_send_remote_refs(
702 struct got_pathlist_head *, struct imsgbuf *);
703 const struct got_error *got_privsep_send_packfd(struct imsgbuf *, int);
704 const struct got_error *got_privsep_recv_send_progress(int *, off_t *,
705 int *, char **, struct imsgbuf *);
706 const struct got_error *got_privsep_get_imsg_obj(struct got_object **,
707 struct imsg *, struct imsgbuf *);
708 const struct got_error *got_privsep_recv_obj(struct got_object **,
709 struct imsgbuf *);
710 const struct got_error *got_privsep_send_raw_obj(struct imsgbuf *, off_t,
711 size_t, uint8_t *);
712 const struct got_error *got_privsep_recv_raw_obj(uint8_t **, off_t *, size_t *,
713 struct imsgbuf *);
714 const struct got_error *got_privsep_send_commit(struct imsgbuf *,
715 struct got_commit_object *);
716 const struct got_error *got_privsep_recv_commit(struct got_commit_object **,
717 struct imsgbuf *);
718 const struct got_error *got_privsep_recv_tree(struct got_tree_object **,
719 struct imsgbuf *);
720 struct got_parsed_tree_entry;
721 const struct got_error *got_privsep_send_tree(struct imsgbuf *,
722 struct got_parsed_tree_entry *, int);
723 const struct got_error *got_privsep_send_blob(struct imsgbuf *, size_t, size_t,
724 const uint8_t *);
725 const struct got_error *got_privsep_recv_blob(uint8_t **, size_t *, size_t *,
726 struct imsgbuf *);
727 const struct got_error *got_privsep_send_tag(struct imsgbuf *,
728 struct got_tag_object *);
729 const struct got_error *got_privsep_recv_tag(struct got_tag_object **,
730 struct imsgbuf *);
731 const struct got_error *got_privsep_init_pack_child(struct imsgbuf *,
732 struct got_pack *, struct got_packidx *);
733 const struct got_error *got_privsep_send_packed_obj_req(struct imsgbuf *, int,
734 struct got_object_id *);
735 const struct got_error *got_privsep_send_packed_raw_obj_req(struct imsgbuf *,
736 int, struct got_object_id *);
737 const struct got_error *got_privsep_send_pack_child_ready(struct imsgbuf *);
739 const struct got_error *got_privsep_send_gitconfig_parse_req(struct imsgbuf *,
740 int);
741 const struct got_error *
742 got_privsep_send_gitconfig_repository_format_version_req(struct imsgbuf *);
743 const struct got_error *got_privsep_send_gitconfig_repository_extensions_req(
744 struct imsgbuf *);
745 const struct got_error *got_privsep_send_gitconfig_author_name_req(
746 struct imsgbuf *);
747 const struct got_error *got_privsep_send_gitconfig_author_email_req(
748 struct imsgbuf *);
749 const struct got_error *got_privsep_send_gitconfig_remotes_req(
750 struct imsgbuf *);
751 const struct got_error *got_privsep_send_gitconfig_owner_req(struct imsgbuf *);
752 const struct got_error *got_privsep_recv_gitconfig_str(char **,
753 struct imsgbuf *);
754 const struct got_error *got_privsep_recv_gitconfig_int(int *, struct imsgbuf *);
755 const struct got_error *got_privsep_recv_gitconfig_remotes(
756 struct got_remote_repo **, int *, struct imsgbuf *);
758 const struct got_error *got_privsep_send_gotconfig_parse_req(struct imsgbuf *,
759 int);
760 const struct got_error *got_privsep_send_gotconfig_author_req(struct imsgbuf *);
761 const struct got_error *got_privsep_send_gotconfig_allowed_signers_req(
762 struct imsgbuf *);
763 const struct got_error *got_privsep_send_gotconfig_revoked_signers_req(
764 struct imsgbuf *);
765 const struct got_error *got_privsep_send_gotconfig_signer_id_req(
766 struct imsgbuf *);
767 const struct got_error *got_privsep_send_gotconfig_remotes_req(
768 struct imsgbuf *);
769 const struct got_error *got_privsep_recv_gotconfig_str(char **,
770 struct imsgbuf *);
771 const struct got_error *got_privsep_recv_gotconfig_remotes(
772 struct got_remote_repo **, int *, struct imsgbuf *);
774 const struct got_error *got_privsep_send_commit_traversal_request(
775 struct imsgbuf *, struct got_object_id *, int, const char *);
776 const struct got_error *got_privsep_recv_traversed_commits(
777 struct got_commit_object **, struct got_object_id **,
778 struct got_object_id_queue *, struct imsgbuf *);
779 const struct got_error *got_privsep_send_enumerated_tree(size_t *,
780 struct imsgbuf *, struct got_object_id *, const char *,
781 struct got_parsed_tree_entry *, int);
782 const struct got_error *got_privsep_send_object_enumeration_request(
783 struct imsgbuf *);
784 const struct got_error *got_privsep_send_object_enumeration_done(
785 struct imsgbuf *);
786 const struct got_error *got_privsep_send_object_enumeration_incomplete(
787 struct imsgbuf *);
788 const struct got_error *got_privsep_send_enumerated_commit(struct imsgbuf *,
789 struct got_object_id *, time_t);
790 const struct got_error *got_privsep_recv_enumerated_objects(int *,
791 struct imsgbuf *, got_object_enumerate_commit_cb,
792 got_object_enumerate_tree_cb, void *, struct got_repository *);
794 const struct got_error *got_privsep_send_raw_delta_req(struct imsgbuf *, int,
795 struct got_object_id *);
796 const struct got_error *got_privsep_send_raw_delta_outfd(struct imsgbuf *, int);
797 const struct got_error *got_privsep_send_raw_delta(struct imsgbuf *, uint64_t,
798 uint64_t, off_t, off_t, off_t, off_t, struct got_object_id *);
799 const struct got_error *got_privsep_recv_raw_delta(uint64_t *, uint64_t *,
800 off_t *, off_t *, off_t *, off_t *, struct got_object_id **,
801 struct imsgbuf *);
803 const struct got_error *got_privsep_send_object_idlist(struct imsgbuf *,
804 struct got_object_id **, size_t);
805 const struct got_error *got_privsep_send_object_idlist_done(struct imsgbuf *);
806 const struct got_error *got_privsep_recv_object_idlist(int *,
807 struct got_object_id **, size_t *, struct imsgbuf *);
809 const struct got_error *got_privsep_send_delta_reuse_req(struct imsgbuf *);
810 const struct got_error *got_privsep_send_reused_deltas(struct imsgbuf *,
811 struct got_imsg_reused_delta *, size_t);
812 const struct got_error *got_privsep_send_reused_deltas_done(struct imsgbuf *);
813 const struct got_error *got_privsep_recv_reused_deltas(int *,
814 struct got_imsg_reused_delta *, size_t *, struct imsgbuf *);
816 const struct got_error *got_privsep_init_commit_painting(struct imsgbuf *);
817 const struct got_error *got_privsep_send_painting_request(struct imsgbuf *,
818 int, struct got_object_id *, intptr_t);
819 typedef const struct got_error *(*got_privsep_recv_painted_commit_cb)(void *,
820 struct got_object_id *, intptr_t);
821 const struct got_error *got_privsep_send_painted_commits(struct imsgbuf *,
822 struct got_object_id_queue *, int *, int, int);
823 const struct got_error *got_privsep_send_painting_commits_done(struct imsgbuf *);
824 const struct got_error *got_privsep_recv_painted_commits(
825 struct got_object_id_queue *, got_privsep_recv_painted_commit_cb, void *,
826 struct imsgbuf *);
828 void got_privsep_exec_child(int[2], const char *, const char *);