pkt-line.h

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