pkt-line.c

   1 #include "cache.h"
   2 #include "pkt-line.h"
   3 #include "run-command.h"
   4
   5 char packet_buffer[LARGE_PACKET_MAX];
   6 static const char *packet_trace_prefix = "git";
   7 static struct trace_key trace_packet = TRACE_KEY_INIT(PACKET);
   8 static struct trace_key trace_pack = TRACE_KEY_INIT(PACKFILE);
   9
  10 void packet_trace_identity(const char *prog)
  11 {
  12         packet_trace_prefix = xstrdup(prog);
  13 }
  14
  15 static const char *get_trace_prefix(void)
  16 {
  17         return in_async() ? "sideband" : packet_trace_prefix;
  18 }
  19
  20 static int packet_trace_pack(const char *buf, unsigned int len, int sideband)
  21 {
  22         if (!sideband) {
  23                 trace_verbatim(&trace_pack, buf, len);
  24                 return 1;
  25         } else if (len && *buf == '\1') {
  26                 trace_verbatim(&trace_pack, buf + 1, len - 1);
  27                 return 1;
  28         } else {
  29                 /* it's another non-pack sideband */
  30                 return 0;
  31         }
  32 }
  33
  34 static void packet_trace(const char *buf, unsigned int len, int write)
  35 {
  36         int i;
  37         struct strbuf out;
  38         static int in_pack, sideband;
  39
  40         if (!trace_want(&trace_packet) && !trace_want(&trace_pack))
  41                 return;
  42
  43         if (in_pack) {
  44                 if (packet_trace_pack(buf, len, sideband))
  45                         return;
  46         } else if (starts_with(buf, "PACK") || starts_with(buf, "\1PACK")) {
  47                 in_pack = 1;
  48                 sideband = *buf == '\1';
  49                 packet_trace_pack(buf, len, sideband);
  50
  51                 /*
  52                  * Make a note in the human-readable trace that the pack data
  53                  * started.
  54                  */
  55                 buf = "PACK ...";
  56                 len = strlen(buf);
  57         }
  58
  59         if (!trace_want(&trace_packet))
  60                 return;
  61
  62         /* +32 is just a guess for header + quoting */
  63         strbuf_init(&out, len+32);
  64
  65         strbuf_addf(&out, "packet: %12s%c ",
  66                     get_trace_prefix(), write ? '>' : '<');
  67
  68         /* XXX we should really handle printable utf8 */
  69         for (i = 0; i < len; i++) {
  70                 /* suppress newlines */
  71                 if (buf[i] == '\n')
  72                         continue;
  73                 if (buf[i] >= 0x20 && buf[i] <= 0x7e)
  74                         strbuf_addch(&out, buf[i]);
  75                 else
  76                         strbuf_addf(&out, "\\%o", buf[i]);
  77         }
  78
  79         strbuf_addch(&out, '\n');
  80         trace_strbuf(&trace_packet, &out);
  81         strbuf_release(&out);
  82 }
  83
  84 /*
  85  * If we buffered things up above (we don't, but we should),
  86  * we'd flush it here
  87  */
  88 void packet_flush(int fd)
  89 {
  90         packet_trace("0000", 4, 1);
  91         write_or_die(fd, "0000", 4);
  92 }
  93
  94 int packet_flush_gently(int fd)
  95 {
  96         packet_trace("0000", 4, 1);
  97         if (write_in_full(fd, "0000", 4) < 0)
  98                 return error("flush packet write failed");
  99         return 0;
 100 }
 101
 102 void packet_buf_flush(struct strbuf *buf)
 103 {
 104         packet_trace("0000", 4, 1);
 105         strbuf_add(buf, "0000", 4);
 106 }
 107
 108 static void set_packet_header(char *buf, const int size)
 109 {
 110         static char hexchar[] = "0123456789abcdef";
 111
 112         #define hex(a) (hexchar[(a) & 15])
 113         buf[0] = hex(size >> 12);
 114         buf[1] = hex(size >> 8);
 115         buf[2] = hex(size >> 4);
 116         buf[3] = hex(size);
 117         #undef hex
 118 }
 119
 120 static void format_packet(struct strbuf *out, const char *fmt, va_list args)
 121 {
 122         size_t orig_len, n;
 123
 124         orig_len = out->len;
 125         strbuf_addstr(out, "0000");
 126         strbuf_vaddf(out, fmt, args);
 127         n = out->len - orig_len;
 128
 129         if (n > LARGE_PACKET_MAX)
 130                 die("protocol error: impossibly long line");
 131
 132         set_packet_header(&out->buf[orig_len], n);
 133         packet_trace(out->buf + orig_len + 4, n - 4, 1);
 134 }
 135
 136 static int packet_write_fmt_1(int fd, int gently,
 137                               const char *fmt, va_list args)
 138 {
 139         struct strbuf buf = STRBUF_INIT;
 140
 141         format_packet(&buf, fmt, args);
 142         if (write_in_full(fd, buf.buf, buf.len) < 0) {
 143                 if (!gently) {
 144                         check_pipe(errno);
 145                         die_errno("packet write with format failed");
 146                 }
 147                 return error("packet write with format failed");
 148         }
 149
 150         return 0;
 151 }
 152
 153 void packet_write_fmt(int fd, const char *fmt, ...)
 154 {
 155         va_list args;
 156
 157         va_start(args, fmt);
 158         packet_write_fmt_1(fd, 0, fmt, args);
 159         va_end(args);
 160 }
 161
 162 int packet_write_fmt_gently(int fd, const char *fmt, ...)
 163 {
 164         int status;
 165         va_list args;
 166
 167         va_start(args, fmt);
 168         status = packet_write_fmt_1(fd, 1, fmt, args);
 169         va_end(args);
 170         return status;
 171 }
 172
 173 static int packet_write_gently(const int fd_out, const char *buf, size_t size)
 174 {
 175         static char packet_write_buffer[LARGE_PACKET_MAX];
 176         size_t packet_size;
 177
 178         if (size > sizeof(packet_write_buffer) - 4)
 179                 return error("packet write failed - data exceeds max packet size");
 180
 181         packet_trace(buf, size, 1);
 182         packet_size = size + 4;
 183         set_packet_header(packet_write_buffer, packet_size);
 184         memcpy(packet_write_buffer + 4, buf, size);
 185         if (write_in_full(fd_out, packet_write_buffer, packet_size) < 0)
 186                 return error("packet write failed");
 187         return 0;
 188 }
 189
 190 void packet_buf_write(struct strbuf *buf, const char *fmt, ...)
 191 {
 192         va_list args;
 193
 194         va_start(args, fmt);
 195         format_packet(buf, fmt, args);
 196         va_end(args);
 197 }
 198
 199 int write_packetized_from_fd(int fd_in, int fd_out)
 200 {
 201         static char buf[LARGE_PACKET_DATA_MAX];
 202         int err = 0;
 203         ssize_t bytes_to_write;
 204
 205         while (!err) {
 206                 bytes_to_write = xread(fd_in, buf, sizeof(buf));
 207                 if (bytes_to_write < 0)
 208                         return COPY_READ_ERROR;
 209                 if (bytes_to_write == 0)
 210                         break;
 211                 err = packet_write_gently(fd_out, buf, bytes_to_write);
 212         }
 213         if (!err)
 214                 err = packet_flush_gently(fd_out);
 215         return err;
 216 }
 217
 218 int write_packetized_from_buf(const char *src_in, size_t len, int fd_out)
 219 {
 220         int err = 0;
 221         size_t bytes_written = 0;
 222         size_t bytes_to_write;
 223
 224         while (!err) {
 225                 if ((len - bytes_written) > LARGE_PACKET_DATA_MAX)
 226                         bytes_to_write = LARGE_PACKET_DATA_MAX;
 227                 else
 228                         bytes_to_write = len - bytes_written;
 229                 if (bytes_to_write == 0)
 230                         break;
 231                 err = packet_write_gently(fd_out, src_in + bytes_written, bytes_to_write);
 232                 bytes_written += bytes_to_write;
 233         }
 234         if (!err)
 235                 err = packet_flush_gently(fd_out);
 236         return err;
 237 }
 238
 239 static int get_packet_data(int fd, char **src_buf, size_t *src_size,
 240                            void *dst, unsigned size, int options)
 241 {
 242         ssize_t ret;
 243
 244         if (fd >= 0 && src_buf && *src_buf)
 245                 die("BUG: multiple sources given to packet_read");
 246
 247         /* Read up to "size" bytes from our source, whatever it is. */
 248         if (src_buf && *src_buf) {
 249                 ret = size < *src_size ? size : *src_size;
 250                 memcpy(dst, *src_buf, ret);
 251                 *src_buf += ret;
 252                 *src_size -= ret;
 253         } else {
 254                 ret = read_in_full(fd, dst, size);
 255                 if (ret < 0)
 256                         die_errno("read error");
 257         }
 258
 259         /* And complain if we didn't get enough bytes to satisfy the read. */
 260         if (ret < size) {
 261                 if (options & PACKET_READ_GENTLE_ON_EOF)
 262                         return -1;
 263
 264                 die("The remote end hung up unexpectedly");
 265         }
 266
 267         return ret;
 268 }
 269
 270 static int packet_length(const char *linelen)
 271 {
 272         int val = hex2chr(linelen);
 273         return (val < 0) ? val : (val << 8) | hex2chr(linelen + 2);
 274 }
 275
 276 int packet_read(int fd, char **src_buf, size_t *src_len,
 277                 char *buffer, unsigned size, int options)
 278 {
 279         int len, ret;
 280         char linelen[4];
 281
 282         ret = get_packet_data(fd, src_buf, src_len, linelen, 4, options);
 283         if (ret < 0)
 284                 return ret;
 285         len = packet_length(linelen);
 286         if (len < 0)
 287                 die("protocol error: bad line length character: %.4s", linelen);
 288         if (!len) {
 289                 packet_trace("0000", 4, 0);
 290                 return 0;
 291         }
 292         len -= 4;
 293         if (len >= size)
 294                 die("protocol error: bad line length %d", len);
 295         ret = get_packet_data(fd, src_buf, src_len, buffer, len, options);
 296         if (ret < 0)
 297                 return ret;
 298
 299         if ((options & PACKET_READ_CHOMP_NEWLINE) &&
 300             len && buffer[len-1] == '\n')
 301                 len--;
 302
 303         buffer[len] = 0;
 304         packet_trace(buffer, len, 0);
 305         return len;
 306 }
 307
 308 static char *packet_read_line_generic(int fd,
 309                                       char **src, size_t *src_len,
 310                                       int *dst_len)
 311 {
 312         int len = packet_read(fd, src, src_len,
 313                               packet_buffer, sizeof(packet_buffer),
 314                               PACKET_READ_CHOMP_NEWLINE);
 315         if (dst_len)
 316                 *dst_len = len;
 317         return (len > 0) ? packet_buffer : NULL;
 318 }
 319
 320 char *packet_read_line(int fd, int *len_p)
 321 {
 322         return packet_read_line_generic(fd, NULL, NULL, len_p);
 323 }
 324
 325 int packet_read_line_gently(int fd, int *dst_len, char **dst_line)
 326 {
 327         int len = packet_read(fd, NULL, NULL,
 328                               packet_buffer, sizeof(packet_buffer),
 329                               PACKET_READ_CHOMP_NEWLINE|PACKET_READ_GENTLE_ON_EOF);
 330         if (dst_len)
 331                 *dst_len = len;
 332         if (dst_line)
 333                 *dst_line = (len > 0) ? packet_buffer : NULL;
 334         return len;
 335 }
 336
 337 char *packet_read_line_buf(char **src, size_t *src_len, int *dst_len)
 338 {
 339         return packet_read_line_generic(-1, src, src_len, dst_len);
 340 }
 341
 342 ssize_t read_packetized_to_strbuf(int fd_in, struct strbuf *sb_out)
 343 {
 344         int packet_len;
 345
 346         size_t orig_len = sb_out->len;
 347         size_t orig_alloc = sb_out->alloc;
 348
 349         for (;;) {
 350                 strbuf_grow(sb_out, LARGE_PACKET_DATA_MAX);
 351                 packet_len = packet_read(fd_in, NULL, NULL,
 352                         /* strbuf_grow() above always allocates one extra byte to
 353                          * store a '\0' at the end of the string. packet_read()
 354                          * writes a '\0' extra byte at the end, too. Let it know
 355                          * that there is already room for the extra byte.
 356                          */
 357                         sb_out->buf + sb_out->len, LARGE_PACKET_DATA_MAX+1,
 358                         PACKET_READ_GENTLE_ON_EOF);
 359                 if (packet_len <= 0)
 360                         break;
 361                 sb_out->len += packet_len;
 362         }
 363
 364         if (packet_len < 0) {
 365                 if (orig_alloc == 0)
 366                         strbuf_release(sb_out);
 367                 else
 368                         strbuf_setlen(sb_out, orig_len);
 369                 return packet_len;
 370         }
 371         return sb_out->len - orig_len;
 372 }