From mboxrd@z Thu Jan 1 00:00:00 1970 From: Stefan Beller Subject: Re: [RFC/PATCH 0/3] protocol v2 Date: Wed, 4 Mar 2015 17:03:22 -0800 Message-ID: References: <20150302092136.GA30278@lanh> <20150303103351.GA4922@lanh> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Cc: Duy Nguyen , Junio C Hamano , Git Mailing List To: Shawn Pearce X-From: git-owner@vger.kernel.org Thu Mar 05 02:03:31 2015 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1YTKCH-0006Fi-Dx for gcvg-git-2@plane.gmane.org; Thu, 05 Mar 2015 02:03:30 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752651AbbCEBDY (ORCPT ); Wed, 4 Mar 2015 20:03:24 -0500 Received: from mail-ie0-f171.google.com ([209.85.223.171]:46951 "EHLO mail-ie0-f171.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751258AbbCEBDX (ORCPT ); Wed, 4 Mar 2015 20:03:23 -0500 Received: by iery20 with SMTP id y20so18847844ier.13 for ; Wed, 04 Mar 2015 17:03:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type; bh=XEAeficMwIWk/iKYAkaQToh/b/gmqMhYU+v9paIaPoQ=; b=X/TBI/baZe/LicL2MVOjfTkWpMfNaWzAv8fKCQv/ji9sIZlsHEvWAMxiz0vh7ZeD/W kL1BUABLl/J5oQ/CikF4NH4yOg4YFhO8B1DRe7iFnk+9u2CDhSvjD3b5QzXKpjLQk622 c4vabcUdTOl+CwLpFWxU5wgHWACTJk/tb/8RLZKghPHwREgi9RWtQj14etjT3XkWsMmL hP9HYiqH+o9I01YOQCKnekN4BV93tNGpjeWUYdzlK7bWNQha2F+uNdVID7t+y/KZQfN3 zNc/ICIBI9Vlst1Y3+IPkAdIRcpBRwkJi8rtr5XUaJyoHnki4bywIZ+3bgY+/VShu27s ZVuw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc:content-type; bh=XEAeficMwIWk/iKYAkaQToh/b/gmqMhYU+v9paIaPoQ=; b=e8zbBYWjiskYQDkHtTUoosbdKzfRDe62Q3o0aji3/ObCX16amyN9VfFVEgOYNlJF+S +QP5S5LIAoFQfj/ZHPFx3Be6S/UXLLRTg6sQOtWc8aH2BVBr5zQKHS6Jp6mWubzht1SV nkQdL7KfgY/H7L49Ui7dGzi6jcgdeaRHFR5xQqptvm1xPP5Ykk9++NuYc0YQ1tbB3wFf uB8R/8FxAbGrlBjmsHxOcOPCf0vlZO5FuJZ2u881jOis/dt0LjnXgTy9NUi4kskC9lBv hmUdqVqRkcemfkVXhnGFWKCAzVb3ey/xPzaAo8EwR3mayTCUTwA45ycHhSqVZ5FM0Zlg kdRQ== X-Gm-Message-State: ALoCoQkEwEkXtPTALKfoLNDIGEFWZF9EsacijMNnOXkUxU7xLpkqLspKLchI6H0dejSvqs1cAa0C X-Received: by 10.50.122.68 with SMTP id lq4mr42735535igb.10.1425517402348; Wed, 04 Mar 2015 17:03:22 -0800 (PST) Received: by 10.107.46.31 with HTTP; Wed, 4 Mar 2015 17:03:22 -0800 (PST) In-Reply-To: Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: On Wed, Mar 4, 2015 at 11:10 AM, Shawn Pearce wrote: > On Wed, Mar 4, 2015 at 4:05 AM, Duy Nguyen wrote: >> On Wed, Mar 4, 2015 at 11:27 AM, Shawn Pearce wrote: >>> Let me go on a different tangent a bit from the current protocol. >>> >>> http://www.grpc.io/ was recently released and is built on the HTTP/2 >>> standard. It uses protobuf as a proven extensibility mechanism. >>> Including a full C based grpc stack just to speak the Git wire >>> protocol is quite likely overkill, but I think the embedding of a >>> proven extensible format inside of a bi-directional framed streaming >>> system like HTTP/2 offers some good guidance. >> >> I'll take this as "learn from grpc, not just reuse grpc" > > Correct, that was what I was trying to say and I just wrote it poorly. > > HTTP 1.x, HTTP/2 and protobuf have proven themselves to be fairly open > to extension and working well in the wild for transports. There is > useful guidance there that we should draw from to try and leave doors > open for the future. > > HTTP/2, protobuf and grpc are fairly complex. I consider any one of > them too complicated for Git specific use. However HTTP/2 is probably > the future of HTTP stacks so we may see it show up in libcurl or > something as popular as libcurl in another 10 years. Hg had some > reasonably sane ideas about building the wire protocol to work well on > HTTP 1.x upfront rather than Git tacking it on much later. > >>> Network protocol parsing is hard. Especially in languages like C where >>> buffer overflows are possible. Or where a client could trivially DoS a >>> server by sending a packet of size uint_max and the server naively >>> trying to malloc() that buffer. Defining the network protocol in an >>> IDL like protobuf 3 and being machine generated from stable well >>> maintained code has its advantages. >> >> I'm still studying the spec, so I can't comment if using IDL/protobuf3 >> is a good idea yet. >> >> But I think at least we can avoid DoS by changing the pkt-line (again) >> a bit: the length 0xffff means that actual length is 0xfffe and the >> next pkt-line is part of this pkt-line. Higher level (upload-pack or >> fetch-pack, for example) must set an upper limit for packet_read() so >> it won't try to concatenate pkt-lines forever. > > pkt-line is a reasonably simple and efficient framing system. A 64 KiB > pkt-line frame only costs ~0.0061% overhead; ~0.0076% overhead if you > are a pack stream in a side-band-64k channel. That is probably more > efficient than HTTP/2 or SSL framing. > > I see no reason to attempt to try and reduce that overhead further. 64 > KiB frame size is enough for anyone to move data efficiently with > these headers. In practice you are going to wrap that up into SSH or > SSL/TLS and those overheads are so much higher it doesn't matter we > have a tiny loss here. > > I think a mistake in the wire protocol was making the pkt-line length > human readable hex, but the sideband channel binary. _If_ we redo the > framing the only change I would make is making the side band readable. > Thus far we have only used 0, 1, 2 for sideband channels. These could > easily be moved into human readable channel ids: > > 'd': currently sideband 0; this is the application data, aka the pack data > 'p': currently sideband 1; this is the progress stream for stderr > 'e': currently sideband 2; there was an error, data in this packet > is the message text, and the connection will shutdown after the > packet. > > And then leave all other sideband values undefined and reserved for > future use, just like they are all open today. > > I am not convinced framing changes are necessary. I would fine with > leaving the sideband streams as 0,1,2... but if we want a text based > protocol for ease of debugging we should be text based across the > board and try very hard to avoid these binary values in the framing, > or ever needing to use a magical NUL byte in the middle of a packet to > find a gap in older parsers for newer data. > > > If you want to build a larger stream like ref advertisement inside a > pkt-line framing without using a pkt-line per ref record, you should > follow the approach used by pack data streams where it uses the 5 byte > side-band pkt-line framing and a side-band channel is allocated for > that data. Application code can then run a side-band demux to yank out > the inner stream and parse it. > > It may be simpler to restrict ref names to be smaller than 64k in > length so you have room for framing and hash value to be transferred > inside of a single pkt-line, then use the pkt-line framing to do the > transfer. > > Today's upload-pack ref advertisment has ~25% overhead. Most of that > is in the duplicated tag name for the peeled refs/tags/v1.0^{} lines. > If you drop those names (but keep the pkt-line and SHA-1), its only > about 8% overhead above the packed-refs file. > > I think optimization efforts for ref advertisement need to focus on > reducing the number of refs sent back and forth, not shrinking the > individual records down smaller. > > > Earlier in this thread Junio raised a point that the flush-pkt is > confusing because it has way too many purposes. I agree. IIRC we have > 0001-0003 as invalid pkt-line headers that could be used for special > markers in the stream. > > For example we could use 0000 flush-pkt as "end of section" and define > 0001 as "i am done speaking and now wait for you to reply". > > I think we need to keep 0004 as "empty packet" in case we ever get > ourselves into a position where it makes sense to pass an empty string > from one end of the connection to another. > > > Running pkt-line inside of side-band-64k is... weird to read. IIRC we > only do that in the smart HTTP protocol to the remote-curl helper, and > this is where Junio's remarks about flush-pkt being confusing come > from. If we rewrote the protocol to have that explicit 0001 "i am done > talking" marker the helper wouldn't need the double framing to > understand how to break up the originally bidirectional packet stream > into a sequence of bursts sent on unidirectional HTTP 1.x. So I think my next steps are to look at grpc and the sideband channel a bit more closely to have an opinion on my own. At the beginning of the zear (Jan 8th) I started collecting data about the refs advertisement. So I saved the output of `git ls-remote` for https://github.com/gitster/git https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git http://anongit.freedesktop.org/git/systemd/systemd.git It's 57 days since I started the collection. For git.git the total size (of all 57 outputs) combined is 7.0 MB. When compressing all into a zip file, we get down to 3.3 MB. (I figure the zip format is not the right way to measure entropy here) So when using tar.xz instead, all of the outputs combined compress to 64.6 kB, while a single output compressed to 52.0 kB (uncompressed at 128kB, which makes sense as we have lots of redundancy with the common re-occurring pattern "refs/heads/" as well as "refs/remotes/". Also the tag lines should not change over time, so we would not need to retransmit them if we know the client has it already. Maybe the transmission of the diff of the ls-remote would help us as well # the current size for each ls-remote in bytes: wc -c git_2015-03-03_01:41:01-08:00 127889 git_2015-03-03_01:41:01-08:00 # The diff of one month: diff git_2015-03-03_01:41:01-08:00 git_2015-02-01_01\:41\:01-08\:00 |wc -c 11257 # Fetch after one week diff git_2015-03-03_01:41:01-08:00 git_2015-02-25_01:41:01-08:00 |wc -c 6308 # just one day: diff git_2015-03-03_01:41:01-08:00 git_2015-03-01_01\:41\:02-08\:00 |wc -c 1881 If anyone wants to experiment with the data I gathered, I can make them available. Thanks for all your different ideas! Stefan