🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.13.4 / . / pkt-line.h
blob: 18eac6483095319806f4c9b301b0f84e0c68d38c [file] [log] [blame]
Linus Torvaldsf3a32142005-06-30 03:50:15[diff] [blame]1#ifndef PKTLINE_H
2#define PKTLINE_H
3
Dennis Stosberg07d68932006-06-26 08:27:07[diff] [blame]4#include "git-compat-util.h"
Shawn O. Pearcef5615d22009-10-31 00:47:21[diff] [blame]5#include "strbuf.h"
Dennis Stosberg07d68932006-06-26 08:27:07[diff] [blame]6
Linus Torvaldsf3a32142005-06-30 03:50:15[diff] [blame]7/*
Jeff Kinge1485422013-02-20 20:01:46[diff] [blame]8 * Write a packetized stream, where each line is preceded by
9 * its length (including the header) as a 4-byte hex number.
10 * A length of 'zero' means end of stream (and a length of 1-3
11 * would be an error).
12 *
13 * This is all pretty stupid, but we use this packetized line
14 * format to make a streaming format possible without ever
15 * over-running the read buffers. That way we'll never read
16 * into what might be the pack data (which should go to another
17 * process entirely).
18 *
19 * The writing side could use stdio, but since the reading
20 * side can't, we stay with pure read/write interfaces.
Linus Torvaldsf3a32142005-06-30 03:50:15[diff] [blame]21 */
22void packet_flush(int fd);
Lars Schneider81c634e2016-10-16 23:20:29[diff] [blame]23void packet_write_fmt(int fd, const char *fmt, ...) __attribute__((format (printf, 2, 3)));
Shawn O. Pearcef5615d22009-10-31 00:47:21[diff] [blame]24void packet_buf_flush(struct strbuf *buf);
25void packet_buf_write(struct strbuf *buf, const char *fmt, ...) __attribute__((format (printf, 2, 3)));
Lars Schneider038ce902016-10-16 23:20:32[diff] [blame]26int packet_flush_gently(int fd);
Lars Schneider70428d12016-10-16 23:20:31[diff] [blame]27int packet_write_fmt_gently(int fd, const char *fmt, ...) __attribute__((format (printf, 2, 3)));
Lars Schneiderbb643d82016-10-16 23:20:34[diff] [blame]28int write_packetized_from_fd(int fd_in, int fd_out);
29int write_packetized_from_buf(const char *src_in, size_t len, int fd_out);
Linus Torvaldsf3a32142005-06-30 03:50:15[diff] [blame]30
Jeff King03809422013-02-20 20:02:10[diff] [blame]31/*
Jeff King4981fe72013-02-23 22:31:34[diff] [blame]32 * Read a packetized line into the buffer, which must be at least size bytes
33 * long. The return value specifies the number of bytes read into the buffer.
34 *
Justin Lebar01689902014-03-31 22:11:46[diff] [blame]35 * If src_buffer and *src_buffer are not NULL, it should point to a buffer
36 * containing the packet data to parse, of at least *src_len bytes. After the
37 * function returns, src_buf will be incremented and src_len decremented by the
38 * number of bytes consumed.
Jeff King4981fe72013-02-23 22:31:34[diff] [blame]39 *
40 * If src_buffer (or *src_buffer) is NULL, then data is read from the
41 * descriptor "fd".
Jeff King03809422013-02-20 20:02:10[diff] [blame]42 *
43 * If options does not contain PACKET_READ_GENTLE_ON_EOF, we will die under any
44 * of the following conditions:
45 *
46 * 1. Read error from descriptor.
47 *
48 * 2. Protocol error from the remote (e.g., bogus length characters).
49 *
50 * 3. Receiving a packet larger than "size" bytes.
51 *
52 * 4. Truncated output from the remote (e.g., we expected a packet but got
53 * EOF, or we got a partial packet followed by EOF).
54 *
55 * If options does contain PACKET_READ_GENTLE_ON_EOF, we will not die on
56 * condition 4 (truncated input), but instead return -1. However, we will still
57 * die for the other 3 conditions.
Jeff King819b9292013-02-20 20:02:28[diff] [blame]58 *
59 * If options contains PACKET_READ_CHOMP_NEWLINE, a trailing newline (if
60 * present) is removed from the buffer before returning.
Jeff King03809422013-02-20 20:02:10[diff] [blame]61 */
62#define PACKET_READ_GENTLE_ON_EOF (1u<<0)
Jeff King819b9292013-02-20 20:02:28[diff] [blame]63#define PACKET_READ_CHOMP_NEWLINE (1u<<1)
Jeff King4981fe72013-02-23 22:31:34[diff] [blame]64int packet_read(int fd, char **src_buffer, size_t *src_len, char
65 *buffer, unsigned size, int options);
Jeff King03809422013-02-20 20:02:10[diff] [blame]66
Jeff King819b9292013-02-20 20:02:28[diff] [blame]67/*
68 * Convenience wrapper for packet_read that is not gentle, and sets the
Jeff King74543a02013-02-20 20:02:57[diff] [blame]69 * CHOMP_NEWLINE option. The return value is NULL for a flush packet,
70 * and otherwise points to a static buffer (that may be overwritten by
71 * subsequent calls). If the size parameter is not NULL, the length of the
72 * packet is written to it.
Jeff King819b9292013-02-20 20:02:28[diff] [blame]73 */
Jeff King74543a02013-02-20 20:02:57[diff] [blame]74char *packet_read_line(int fd, int *size);
75
Jeff King4981fe72013-02-23 22:31:34[diff] [blame]76/*
77 * Same as packet_read_line, but read from a buf rather than a descriptor;
78 * see packet_read for details on how src_* is used.
79 */
80char *packet_read_line_buf(char **src_buf, size_t *src_len, int *size);
Jeff King03809422013-02-20 20:02:10[diff] [blame]81
Lars Schneiderbb643d82016-10-16 23:20:34[diff] [blame]82/*
83 * Reads a stream of variable sized packets until a flush packet is detected.
84 */
85ssize_t read_packetized_to_strbuf(int fd_in, struct strbuf *sb_out);
86
Jeff King047ec602013-02-20 20:02:45[diff] [blame]87#define DEFAULT_PACKET_MAX 1000
88#define LARGE_PACKET_MAX 65520
Lars Schneiderbb643d82016-10-16 23:20:34[diff] [blame]89#define LARGE_PACKET_DATA_MAX (LARGE_PACKET_MAX - 4)
Jeff King74543a02013-02-20 20:02:57[diff] [blame]90extern char packet_buffer[LARGE_PACKET_MAX];
Jeff King047ec602013-02-20 20:02:45[diff] [blame]91
Linus Torvaldsf3a32142005-06-30 03:50:15[diff] [blame]92#endif