]>
Commit | Line | Data |
---|---|---|
f3a3214e LT |
1 | #ifndef PKTLINE_H |
2 | #define PKTLINE_H | |
3 | ||
07d68930 | 4 | #include "git-compat-util.h" |
f5615d24 | 5 | #include "strbuf.h" |
fbd76cd4 | 6 | #include "sideband.h" |
07d68930 | 7 | |
f3a3214e | 8 | /* |
e1485428 JK |
9 | * Write a packetized stream, where each line is preceded by |
10 | * its length (including the header) as a 4-byte hex number. | |
11 | * A length of 'zero' means end of stream (and a length of 1-3 | |
12 | * would be an error). | |
13 | * | |
14 | * This is all pretty stupid, but we use this packetized line | |
15 | * format to make a streaming format possible without ever | |
16 | * over-running the read buffers. That way we'll never read | |
17 | * into what might be the pack data (which should go to another | |
18 | * process entirely). | |
19 | * | |
20 | * The writing side could use stdio, but since the reading | |
21 | * side can't, we stay with pure read/write interfaces. | |
f3a3214e LT |
22 | */ |
23 | void packet_flush(int fd); | |
a4cfd41c | 24 | void packet_delim(int fd); |
0181b600 | 25 | void packet_response_end(int fd); |
81c634e9 | 26 | void packet_write_fmt(int fd, const char *fmt, ...) __attribute__((format (printf, 2, 3))); |
f5615d24 | 27 | void packet_buf_flush(struct strbuf *buf); |
a4cfd41c | 28 | void packet_buf_delim(struct strbuf *buf); |
a97d0079 | 29 | void set_packet_header(char *buf, int size); |
5d2124b3 | 30 | void packet_write(int fd_out, const char *buf, size_t size); |
f5615d24 | 31 | void packet_buf_write(struct strbuf *buf, const char *fmt, ...) __attribute__((format (printf, 2, 3))); |
038ce90f | 32 | int packet_flush_gently(int fd); |
70428d1a | 33 | int packet_write_fmt_gently(int fd, const char *fmt, ...) __attribute__((format (printf, 2, 3))); |
3a63c6a4 JS |
34 | int write_packetized_from_fd_no_flush(int fd_in, int fd_out); |
35 | int write_packetized_from_buf_no_flush(const char *src_in, size_t len, int fd_out); | |
f3a3214e | 36 | |
96328398 JV |
37 | /* |
38 | * Stdio versions of packet_write functions. When mixing these with fd | |
39 | * based functions, take care to call fflush(3) before doing fd writes or | |
40 | * closing the fd. | |
41 | */ | |
42 | void packet_fwrite(FILE *f, const char *buf, size_t size); | |
43 | void packet_fwrite_fmt(FILE *f, const char *fmt, ...) __attribute__((format (printf, 2, 3))); | |
44 | ||
45 | /* packet_fflush writes a flush packet and flushes the stdio buffer of f */ | |
46 | void packet_fflush(FILE *f); | |
47 | ||
03809429 | 48 | /* |
4981fe75 JK |
49 | * Read a packetized line into the buffer, which must be at least size bytes |
50 | * long. The return value specifies the number of bytes read into the buffer. | |
51 | * | |
03809429 JK |
52 | * If options does not contain PACKET_READ_GENTLE_ON_EOF, we will die under any |
53 | * of the following conditions: | |
54 | * | |
55 | * 1. Read error from descriptor. | |
56 | * | |
57 | * 2. Protocol error from the remote (e.g., bogus length characters). | |
58 | * | |
59 | * 3. Receiving a packet larger than "size" bytes. | |
60 | * | |
61 | * 4. Truncated output from the remote (e.g., we expected a packet but got | |
62 | * EOF, or we got a partial packet followed by EOF). | |
63 | * | |
64 | * If options does contain PACKET_READ_GENTLE_ON_EOF, we will not die on | |
65 | * condition 4 (truncated input), but instead return -1. However, we will still | |
66 | * die for the other 3 conditions. | |
819b929d JK |
67 | * |
68 | * If options contains PACKET_READ_CHOMP_NEWLINE, a trailing newline (if | |
69 | * present) is removed from the buffer before returning. | |
2d103c31 MS |
70 | * |
71 | * If options contains PACKET_READ_DIE_ON_ERR_PACKET, it dies when it sees an | |
72 | * ERR packet. | |
c4ba5793 JS |
73 | * |
74 | * If options contains PACKET_READ_GENTLE_ON_READ_ERROR, we will not die | |
75 | * on read errors, but instead return -1. However, we may still die on an | |
76 | * ERR packet (if requested). | |
03809429 | 77 | */ |
c4ba5793 JS |
78 | #define PACKET_READ_GENTLE_ON_EOF (1u<<0) |
79 | #define PACKET_READ_CHOMP_NEWLINE (1u<<1) | |
80 | #define PACKET_READ_DIE_ON_ERR_PACKET (1u<<2) | |
81 | #define PACKET_READ_GENTLE_ON_READ_ERROR (1u<<3) | |
88e9b1e3 | 82 | #define PACKET_READ_REDACT_URI_PATH (1u<<4) |
ec9a37d6 | 83 | int packet_read(int fd, char *buffer, unsigned size, int options); |
03809429 | 84 | |
101736a1 DL |
85 | /* |
86 | * Convert a four hex digit packet line length header into its numeric | |
87 | * representation. | |
88 | * | |
89 | * If lenbuf_hex contains non-hex characters, return -1. Otherwise, return the | |
90 | * numeric value of the length header. | |
91 | */ | |
92 | int packet_length(const char lenbuf_hex[4]); | |
93 | ||
2153d478 BW |
94 | /* |
95 | * Read a packetized line into a buffer like the 'packet_read()' function but | |
96 | * returns an 'enum packet_read_status' which indicates the status of the read. | |
a4fb016b | 97 | * The number of bytes read will be assigned to *pktlen if the status of the |
2153d478 | 98 | * read was 'PACKET_READ_NORMAL'. |
ce5f0798 MT |
99 | * |
100 | * If src_buffer and *src_buffer are not NULL, it should point to a buffer | |
101 | * containing the packet data to parse, of at least *src_len bytes. After the | |
102 | * function returns, src_buf will be incremented and src_len decremented by the | |
103 | * number of bytes consumed. | |
104 | * | |
105 | * If src_buffer (or *src_buffer) is NULL, then data is read from the | |
106 | * descriptor "fd". | |
2153d478 BW |
107 | */ |
108 | enum packet_read_status { | |
109 | PACKET_READ_EOF, | |
110 | PACKET_READ_NORMAL, | |
111 | PACKET_READ_FLUSH, | |
a4cfd41c | 112 | PACKET_READ_DELIM, |
0181b600 | 113 | PACKET_READ_RESPONSE_END, |
2153d478 BW |
114 | }; |
115 | enum packet_read_status packet_read_with_status(int fd, char **src_buffer, | |
116 | size_t *src_len, char *buffer, | |
117 | unsigned size, int *pktlen, | |
118 | int options); | |
119 | ||
819b929d JK |
120 | /* |
121 | * Convenience wrapper for packet_read that is not gentle, and sets the | |
74543a04 JK |
122 | * CHOMP_NEWLINE option. The return value is NULL for a flush packet, |
123 | * and otherwise points to a static buffer (that may be overwritten by | |
124 | * subsequent calls). If the size parameter is not NULL, the length of the | |
125 | * packet is written to it. | |
819b929d | 126 | */ |
74543a04 JK |
127 | char *packet_read_line(int fd, int *size); |
128 | ||
825b9226 BP |
129 | /* |
130 | * Convenience wrapper for packet_read that sets the PACKET_READ_GENTLE_ON_EOF | |
131 | * and CHOMP_NEWLINE options. The return value specifies the number of bytes | |
132 | * read into the buffer or -1 on truncated input. If the *dst_line parameter | |
133 | * is not NULL it will return NULL for a flush packet or when the number of | |
134 | * bytes copied is zero and otherwise points to a static buffer (that may be | |
135 | * overwritten by subsequent calls). If the size parameter is not NULL, the | |
136 | * length of the packet is written to it. | |
137 | */ | |
138 | int packet_read_line_gently(int fd, int *size, char **dst_line); | |
139 | ||
bb643d8b LS |
140 | /* |
141 | * Reads a stream of variable sized packets until a flush packet is detected. | |
142 | */ | |
8c2efa5d | 143 | ssize_t read_packetized_to_strbuf(int fd_in, struct strbuf *sb_out, int options); |
bb643d8b | 144 | |
fbd76cd4 JT |
145 | /* |
146 | * Receive multiplexed output stream over git native protocol. | |
147 | * in_stream is the input stream from the remote, which carries data | |
148 | * in pkt_line format with band designator. Demultiplex it into out | |
149 | * and err and return error appropriately. Band #1 carries the | |
150 | * primary payload. Things coming over band #2 is not necessarily | |
151 | * error; they are usually informative message on the standard error | |
152 | * stream, aka "verbose"). A message over band #3 is a signal that | |
153 | * the remote died unexpectedly. A flush() concludes the stream. | |
154 | * | |
155 | * Returns SIDEBAND_FLUSH upon a normal conclusion, and SIDEBAND_PROTOCOL_ERROR | |
156 | * or SIDEBAND_REMOTE_ERROR if an error occurred. | |
157 | */ | |
158 | int recv_sideband(const char *me, int in_stream, int out); | |
159 | ||
77dabc14 BW |
160 | struct packet_reader { |
161 | /* source file descriptor */ | |
162 | int fd; | |
163 | ||
164 | /* source buffer and its size */ | |
165 | char *src_buffer; | |
166 | size_t src_len; | |
167 | ||
168 | /* buffer that pkt-lines are read into and its size */ | |
169 | char *buffer; | |
170 | unsigned buffer_size; | |
171 | ||
172 | /* options to be used during reads */ | |
173 | int options; | |
174 | ||
175 | /* status of the last read */ | |
176 | enum packet_read_status status; | |
177 | ||
178 | /* length of data read during the last read */ | |
179 | int pktlen; | |
180 | ||
181 | /* the last line read */ | |
182 | const char *line; | |
183 | ||
184 | /* indicates if a line has been peeked */ | |
185 | int line_peeked; | |
0bbc0bc5 JT |
186 | |
187 | unsigned use_sideband : 1; | |
188 | const char *me; | |
9a9f0d3f | 189 | |
190 | /* hash algorithm in use */ | |
191 | const struct git_hash_algo *hash_algo; | |
77dabc14 BW |
192 | }; |
193 | ||
194 | /* | |
195 | * Initialize a 'struct packet_reader' object which is an | |
196 | * abstraction around the 'packet_read_with_status()' function. | |
197 | */ | |
55454427 | 198 | void packet_reader_init(struct packet_reader *reader, int fd, |
ad6dad09 DL |
199 | char *src_buffer, size_t src_len, |
200 | int options); | |
77dabc14 BW |
201 | |
202 | /* | |
203 | * Perform a packet read and return the status of the read. | |
204 | * The values of 'pktlen' and 'line' are updated based on the status of the | |
205 | * read as follows: | |
206 | * | |
207 | * PACKET_READ_ERROR: 'pktlen' is set to '-1' and 'line' is set to NULL | |
208 | * PACKET_READ_NORMAL: 'pktlen' is set to the number of bytes read | |
209 | * 'line' is set to point at the read line | |
210 | * PACKET_READ_FLUSH: 'pktlen' is set to '0' and 'line' is set to NULL | |
211 | */ | |
55454427 | 212 | enum packet_read_status packet_reader_read(struct packet_reader *reader); |
77dabc14 BW |
213 | |
214 | /* | |
215 | * Peek the next packet line without consuming it and return the status. | |
216 | * The next call to 'packet_reader_read()' will perform a read of the same line | |
217 | * that was peeked, consuming the line. | |
218 | * | |
219 | * Peeking multiple times without calling 'packet_reader_read()' will return | |
220 | * the same result. | |
221 | */ | |
55454427 | 222 | enum packet_read_status packet_reader_peek(struct packet_reader *reader); |
77dabc14 | 223 | |
047ec602 JK |
224 | #define DEFAULT_PACKET_MAX 1000 |
225 | #define LARGE_PACKET_MAX 65520 | |
bb643d8b | 226 | #define LARGE_PACKET_DATA_MAX (LARGE_PACKET_MAX - 4) |
74543a04 | 227 | extern char packet_buffer[LARGE_PACKET_MAX]; |
047ec602 | 228 | |
bc2e795c JT |
229 | struct packet_writer { |
230 | int dest_fd; | |
0bbc0bc5 | 231 | unsigned use_sideband : 1; |
bc2e795c JT |
232 | }; |
233 | ||
234 | void packet_writer_init(struct packet_writer *writer, int dest_fd); | |
235 | ||
236 | /* These functions die upon failure. */ | |
237 | __attribute__((format (printf, 2, 3))) | |
238 | void packet_writer_write(struct packet_writer *writer, const char *fmt, ...); | |
239 | __attribute__((format (printf, 2, 3))) | |
240 | void packet_writer_error(struct packet_writer *writer, const char *fmt, ...); | |
241 | void packet_writer_delim(struct packet_writer *writer); | |
242 | void packet_writer_flush(struct packet_writer *writer); | |
243 | ||
f3a3214e | 244 | #endif |