2 7be7cc45 2018-04-02 stsp * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 7be7cc45 2018-04-02 stsp * Permission to use, copy, modify, and distribute this software for any
5 7be7cc45 2018-04-02 stsp * purpose with or without fee is hereby granted, provided that the above
6 7be7cc45 2018-04-02 stsp * copyright notice and this permission notice appear in all copies.
8 7be7cc45 2018-04-02 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 7be7cc45 2018-04-02 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 7be7cc45 2018-04-02 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 7be7cc45 2018-04-02 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 7be7cc45 2018-04-02 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 7be7cc45 2018-04-02 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 7be7cc45 2018-04-02 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 7be7cc45 2018-04-02 stsp * All code runs under the same UID but sensitive code paths are
19 7be7cc45 2018-04-02 stsp * run in a separate process with tighter pledge(2) promises.
20 2ca3a24b 2018-04-02 stsp * Data is communicated between processes via imsg_flush(3) and imsg_read(3).
21 7be7cc45 2018-04-02 stsp * This behaviour is transparent to users of the library.
23 1e4880cb 2018-04-02 stsp * We generally transmit data in imsg buffers, split across several messages
24 1e4880cb 2018-04-02 stsp * if necessary. File descriptor passing is used in cases where this is
25 1e4880cb 2018-04-02 stsp * impractical, such as when accessing pack files or when transferring
26 1e4880cb 2018-04-02 stsp * large blobs.
28 7be7cc45 2018-04-02 stsp * We currently do not exec(2) after a fork(2).
29 0dacc2d1 2018-04-02 stsp * To achieve fork+exec, relevant parts of our library functionality could
30 7be7cc45 2018-04-02 stsp * be made accessible via separate executables in a libexec directory.
33 7be7cc45 2018-04-02 stsp enum got_imsg_type {
34 c025a41e 2018-04-02 stsp /* An error occured while processing a request. */
35 c025a41e 2018-04-02 stsp GOT_IMSG_ERROR,
37 1e4880cb 2018-04-02 stsp /* Messages for transmitting deltas and associated delta streams. */
38 1e4880cb 2018-04-02 stsp GOT_IMSG_DELTA,
39 1e4880cb 2018-04-02 stsp GOT_IMSG_DELTA_STREAM,
42 7be7cc45 2018-04-02 stsp * Messages concerned with read access to objects in a repository.
43 7be7cc45 2018-04-02 stsp * Object and pack files are opened by the main process, where
44 7be7cc45 2018-04-02 stsp * data may be read as a byte string but without any interpretation.
45 7be7cc45 2018-04-02 stsp * Decompression and parsing of object and pack files occurs in a
46 7be7cc45 2018-04-02 stsp * separate process which runs under pledge("stdio").
47 7be7cc45 2018-04-02 stsp * This sandboxes our own repository parsing code, as well as zlib.
49 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_OBJECT_HEADER_REQUEST,
50 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_OBJECT_HEADER_REPLY,
51 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_BLOB_OBJECT_REQUEST,
52 48f392b2 2018-04-02 stsp GOT_IMSG_LOOSE_BLOB_OBJECT_REQUEST_OUTPUT,
53 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_BLOB_OBJECT_REPLY,
54 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_TREE_OBJECT_REQUEST,
55 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_TREE_OBJECT_REPLY,
56 48f392b2 2018-04-02 stsp GOT_IMSG_TREE_ENTRY,
57 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_COMMIT_OBJECT_REQUEST,
58 f7171542 2018-04-02 stsp GOT_IMSG_LOOSE_COMMIT_OBJECT_REPLY,
59 f7171542 2018-04-02 stsp GOT_IMSG_PACKED_BLOB_OBJECT_REQUEST,
60 48f392b2 2018-04-02 stsp GOT_IMSG_PACKED_BLOB_OBJECT_REQUEST_OUTPUT,
61 f7171542 2018-04-02 stsp GOT_IMSG_PACKED_BLOB_OBJECT_REPLY,
62 f7171542 2018-04-02 stsp GOT_IMSG_PACKED_TREE_OBJECT_REQUEST,
63 f7171542 2018-04-02 stsp GOT_IMSG_PACKED_TREE_OBJECT_REPLY,
64 f7171542 2018-04-02 stsp GOT_IMSG_PACKED_COMMIT_OBJECT_REQUEST,
65 f7171542 2018-04-02 stsp GOT_IMSG_PACKED_COMMIT_OBJECT_REPLY
68 c025a41e 2018-04-02 stsp /* Structure for GOT_IMSG_ERROR. */
69 c025a41e 2018-04-02 stsp struct got_imsg_error {
70 c025a41e 2018-04-02 stsp int code; /* an error code from got_error.h */
73 1e4880cb 2018-04-02 stsp /* Structure for GOT_IMSG_DELTA data. */
74 1e4880cb 2018-04-02 stsp struct got_imsg_delta {
75 1e4880cb 2018-04-02 stsp /* These fields are the same as in struct got_delta. */
76 1e4880cb 2018-04-02 stsp off_t offset;
77 1e4880cb 2018-04-02 stsp size_t tslen;
79 1e4880cb 2018-04-02 stsp size_t size;
80 1e4880cb 2018-04-02 stsp off_t data_offset;
81 1e4880cb 2018-04-02 stsp size_t delta_len;
84 48f392b2 2018-04-02 stsp * Followed by delta stream in remaining bytes of imsg buffer.
85 48f392b2 2018-04-02 stsp * If delta_len exceeds imsg buffer length, followed by one or
86 48f392b2 2018-04-02 stsp * more DELTA_STREAM messages until delta_len bytes of delta
87 48f392b2 2018-04-02 stsp * stream have been transmitted.
91 1e4880cb 2018-04-02 stsp /* Structure for GOT_IMSG_DELTA_STREAM data. */
92 1e4880cb 2018-04-02 stsp struct got_imsg_delta_stream {
94 1e4880cb 2018-04-02 stsp * Empty since the following is implied:
95 48f392b2 2018-04-02 stsp * Read additional delta stream data from imsg buffer.
99 f7171542 2018-04-02 stsp /* Structure for GOT_IMSG_LOOSE_OBJECT_HEADER_REQUEST data. */
100 f7171542 2018-04-02 stsp struct got_imsg_loose_object_header_request {
102 7be7cc45 2018-04-02 stsp * Empty since the following is implied: If imsg fd == -1 then
103 7be7cc45 2018-04-02 stsp * read raw object data from imsg buffer, else read from fd.
107 f7171542 2018-04-02 stsp /* Structure for transmitting struct got_object data in an imsg. */
108 f7171542 2018-04-02 stsp struct got_imsg_object {
109 7be7cc45 2018-04-02 stsp /* These fields are the same as in struct got_object. */
112 7be7cc45 2018-04-02 stsp size_t hdrlen;
113 7be7cc45 2018-04-02 stsp size_t size;
114 7be7cc45 2018-04-02 stsp struct got_object_id id;
116 7be7cc45 2018-04-02 stsp int ndeltas; /* this many GOT_IMSG_DELTA messages follow */
117 8d98bcfb 2018-04-02 stsp } __attribute__((__packed__));
119 f7171542 2018-04-02 stsp /* Structure for GOT_IMSG_LOOSE_OBJECT_HEADER_REPLY data. */
120 f7171542 2018-04-02 stsp struct got_imsg_loose_object_header_reply {
121 f7171542 2018-04-02 stsp struct got_imsg_object iobj;
124 48f392b2 2018-04-02 stsp /* Structure for GOT_IMSG_LOOSE_BLOB_OBJECT_REQUEST data. */
125 48f392b2 2018-04-02 stsp struct got_imsg_loose_blob_object_request {
126 48f392b2 2018-04-02 stsp struct got_imsg_object iobj;
129 48f392b2 2018-04-02 stsp * The following is implied: If imsg fd == -1 then read raw
130 48f392b2 2018-04-02 stsp * blob data from imsg buffer, else read from fd.
134 48f392b2 2018-04-02 stsp /* Structure for GOT_IMSG_LOOSE_BLOB_OBJECT_REQUEST_OUTPUT data. */
135 48f392b2 2018-04-02 stsp struct got_imsg_loose_blob_object_request_output {
137 48f392b2 2018-04-02 stsp * Empty since the following is implied: If imsg fd == -1 then
138 48f392b2 2018-04-02 stsp * respond with blob data in imsg buffer, else write to fd.
142 48f392b2 2018-04-02 stsp /* Structure for GOT_IMSG_LOOSE_TREE_OBJECT_REQUEST data. */
143 48f392b2 2018-04-02 stsp struct got_imsg_loose_tree_object_request {
144 48f392b2 2018-04-02 stsp struct got_imsg_object iobj;
147 48f392b2 2018-04-02 stsp * The following is implied: If imsg fd == -1 then read raw tree
148 48f392b2 2018-04-02 stsp * data from imsg buffer, else read from fd.
152 48f392b2 2018-04-02 stsp /* Structure for GOT_IMSG_TREE_ENTRY. */
153 48f392b2 2018-04-02 stsp struct got_imsg_tree_entry {
154 48f392b2 2018-04-02 stsp struct got_object_id id;
155 48f392b2 2018-04-02 stsp mode_t mode;
156 48f392b2 2018-04-02 stsp /* Followed by entry's name in remaining data of imsg buffer. */
157 8d98bcfb 2018-04-02 stsp } __attribute__((__packed__));
159 48f392b2 2018-04-02 stsp /* Structure for transmitting struct got_tree_object data in an imsg. */
160 48f392b2 2018-04-02 stsp struct got_imsg_tree_object {
161 48f392b2 2018-04-02 stsp int nentries; /* This many TREE_ENTRY messages follow. */
164 7be7cc45 2018-04-02 stsp /* TODO: Implement the above, and then add more message data types here. */
