mirror of https://gitea.invidious.io/iv-org/litespeed-quic.git synced 2024-08-15 00:53:43 +00:00

No description

Find a file

Dmitri Tikhonov 16a9b66aaa Latest changes - [OPTIMIZATION] Merge series of ACKs if possible Parsed single-range ACK frames (that is the majority of frames) are saved in the connection and their processing is deferred until the connection is ticked. If several ACKs come in a series between adjacent ticks, we check whether the latest ACK is a strict superset of the saved ACK. If it is, the older ACK is not processed. If ACK frames can be merged, they are merged and only one of them is either processed or saved. - [OPTIMIZATION] Speed up ACK verification by simplifying send history. Never generate a gap in the sent packet number sequence. This reduces the send history to a single number instead of potentially a series of packet ranges and thereby speeds up ACK verification. By default, detecting a gap in the send history is not fatal: only a single warning is generated per connection. The connection can continue to operate even if the ACK verification code is not able to detect some inconsistencies. - [OPTIMIZATION] Rearrange the lsquic_send_ctl struct The first part of struct lsquic_send_ctl now consists of members that are used in lsquic_send_ctl_got_ack() (in the absense of packet loss, which is the normal case). To speed up reads and writes, we no longer try to save space by using 8- and 16-bit integers. Use regular integer width for everything. - [OPTIMIZATION] Cache size of sent packet. - [OPTIMIZATION] Keep track of the largest ACKed in packet_out Instead of parsing our own ACK frames when packet has been acked, use the value saved in the packet_out structure when the ACK frame was generated. - [OPTIMIZATION] Take RTT sampling conditional out of ACK loop - [OPTIMIZATION] ACK processing: only call clock_gettime() if needed - [OPTIMIZATION] Several code-level optimizations to ACK processing. - Fix: http_client: fix -I flag; switch assert() to abort()		2018-03-09 14:17:39 -05:00
docs	Latest changes	2017-10-31 09:35:58 -04:00
include	Latest changes	2018-02-28 14:25:21 -05:00
src	Latest changes	2018-03-09 14:17:39 -05:00
test	Latest changes	2018-03-09 14:17:39 -05:00
APIs.txt	Add APIs.txt -- describe LSQUIC APIs on high level	2017-10-31 14:28:04 -04:00
CHANGELOG	Latest changes	2018-03-09 14:17:39 -05:00
CMakeLists.txt	Latest changes	2018-03-09 14:17:39 -05:00
Dockerfile	Add basic Dockerfile	2017-10-03 15:33:09 -04:00
dox.cfg	LSQUIC Client: Initial release	2017-09-22 17:00:03 -04:00
EXAMPLES.txt	Latest changes	2018-02-26 16:01:16 -05:00
LICENSE	LSQUIC Client: Initial release	2017-09-22 17:00:03 -04:00
LICENSE.chrome	LSQUIC Client: Initial release	2017-09-22 17:00:03 -04:00
README.md	Update README with Docker instructions.	2017-10-03 15:37:20 -04:00

README.md

LiteSpeed QUIC (LSQUIC) Client Library README

Description

LiteSpeed QUIC (LSQUIC) Client Library is an open-source implementation of QUIC functionality for clients. It is released in the hope to speed the adoption of QUIC. Most of the code in this distribution is used in our own products: LiteSpeed Web Server and ADC. We think it is free of major problems. Nevertheless, do not hesitate to report bugs back to us. Even better, send us fixes and improvements!

Currently supported QUIC versions are Q035, Q037, Q038, Q039, and Q041. Support for newer versions will be added soon after they are released. The version(s) specified by IETF QUIC WG will be added once the IETF version of the protocol settles down a little.

Documentation

The documentation for this module is admittedly sparse. The API is documented in include/lsquic.h. If you have doxygen, you can run doxygen dox.cfg or make docs. The example program is test/http_client.c: a bare-bones, but working, QUIC client. Have a look in EXAMPLES.txt to see how it can be used.

Requirements

To build LSQUIC, you need CMake, zlib, and BoringSSL. The example program uses libevent to provide the event loop.

Building BoringSSL

BoringSSL is not packaged; you have to build it yourself. The process is straightforward. You will need go installed.

Clone BoringSSL by issuing the following command:

git clone https://boringssl.googlesource.com/boringssl
cd boringssl

Check out stable branch:

git checkout chromium-stable

Compile the library

cmake . &&  make

If you want to turn on optimizations, do

cmake -DCMAKE_BUILD_TYPE=Release . && make

Install the library

This is the manual step. You will need to copy library files manually. LSQUIC client library needs two: ssl/libssl.a and crypto/libcrypto.a. To install these in /usr/local/lib, you should do the following:

BORINGSSL_SOURCE=$PWD
cd /usr/local/lib
sudo cp $BORINGSSL_SOURCE/ssl/libssl.a .
sudo cp $BORINGSSL_SOURCE/crypto/libcrypto.a .

If you do not want to install the library (or do not have root), you can do this instead:

BORINGSSL_SOURCE=$PWD
mkdir -p $HOME/tmp/boringssl-libs
cd $HOME/tmp/boringssl-libs
ln -s $BORINGSSL_SOURCE/ssl/libssl.a
ln -s $BORINGSSL_SOURCE/crypto/libcrypto.a

Building LSQUIC Client Library

LSQUIC's http_client and the tests link BoringSSL libraries statically. Following previous section, you can build LSQUIC as follows:

Get the source code

git clone https://github.com/litespeedtech/lsquic-client.git
cd lsquic-client

Compile the library

cmake -DBORINGSSL_INCLUDE=$BORINGSSL_SOURCE/include \
                                -DBORINGSSL_LIB=$HOME/tmp/boringssl-libs .
make

Run tests

make test

Building with Docker

The library and http_client example can be built with Docker.

docker build -t lsquic-client .

Then you can use the http_client example from the command line.

docker run -it --rm lsquic-client http_client -H www.google.com -s 74.125.22.106:443 -p /

Platforms

The client library has been tested on the following platforms:

Linux
- x86_64
- ARM (Raspberry Pi 3)
FreeBSD
- i386
MacOS
- x86_64

Have fun,

LiteSpeed QUIC Team.