lsqpack 0.1.0

data/ls-qpack/test/qifs/netbsd.qif

@@ -0,0 +1,235 @@
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+connection	keep-alive
+upgrade-insecure-requests	1
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/global.css
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	text/css,*/*;q=0.1
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/global.js
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/donations/donors.js
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/NetBSD-smaller.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/download-icon-orange.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/support-icon-orange.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/community-icon-orange.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/develop-icon-orange.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/donate-icon-orange.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/links/paypal.gif
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/links/stripe-black-donate-small.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/links/cafepress.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/westernlogo_sm.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/columbia.jpg
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/fastly.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	http
+:authority	www.netbsd.org
+:path	/images/navBar-gradient.png
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate
+referer	http://www.netbsd.org/global.css
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+
+:method	GET
+:scheme	https
+:authority	www.paypalobjects.com
+:path	/en_US/i/btn/btn_subscribe_SM.gif
+user-agent	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:58.0) Gecko/20100101 Firefox/58.0
+accept	*/*
+accept-language	en-US,en;q=0.5
+accept-encoding	gzip, deflate, br
+referer	http://www.netbsd.org/
+cookie	PYPF=CT-2
+connection	keep-alive
+pragma	no-cache
+cache-control	no-cache
+

data/ls-qpack/test/run-qif.pl

@@ -0,0 +1,97 @@
+#!/usr/bin/perl
+#
+# Script to run a QIF file.
+
+use strict;
+use warnings;
+
+use File::Compare qw(compare);
+use File::Copy qw(copy);
+use File::Path qw(remove_tree);
+use File::Spec::Functions qw(catfile);
+use Getopt::Long qw(GetOptions);
+
+my $cleanup = 1;
+
+GetOptions(
+    "aggressive=i"      => \my $aggressive,
+    "table-size=i"      => \my $table_size,
+    "immed-ack=i"       => \my $immed_ack,
+    "risked-streams=i"  => \my $risked_streams,
+    "no-cleanup"        => sub { $cleanup = 0 },
+);
+
+my $dir = catfile(($ENV{TMP} || $ENV{TEMP} || "/tmp"),
+                                                "run-qif-out-" . rand . $$);
+mkdir $dir or die "cannot create temp directory $dir";
+if (!$cleanup)
+{
+    print "created temp directory: $dir\n";
+}
+
+END {
+    if (defined($dir) && $cleanup) {
+        remove_tree($dir);
+    }
+}
+
+my $encode_log = catfile($dir, "encode.log");
+my $qif_file = catfile($dir, "qif");
+my $bin_file = catfile($dir, "out");
+my $resulting_qif_file = catfile($dir, "qif-result");
+
+my ($encode_args, $decode_args) = ('', '');
+if ($aggressive) {
+    $encode_args="$encode_args -A";
+}
+
+if ($immed_ack) {
+    $encode_args="$encode_args -a 1";
+}
+
+if (defined $risked_streams) {
+    $encode_args = "$encode_args -s $risked_streams";
+    $decode_args = "$decode_args -s $risked_streams";
+}
+
+if (defined $table_size) {
+    $encode_args = "$encode_args -t $table_size";
+    $decode_args = "$decode_args -t $table_size";
+}
+
+copy($ARGV[0], $qif_file) or die "cannot copy original $ARGV[0] to $qif_file";
+
+if ($^O eq 'MSWin32') {
+    system('interop-encode', $encode_args, '-i', $qif_file, '-o', $bin_file)
+        and die "interop-encode failed";
+    system('interop-decode', $decode_args, '-m', '1', '-i', $bin_file, '-o', $resulting_qif_file)
+        and die "interop-decode failed";
+} else {
+    system("interop-encode $encode_args -i $qif_file -o $bin_file")
+        and die "interop-encode failed";
+    system("interop-decode $decode_args -m 1 -i $bin_file -o $resulting_qif_file")
+        and die "interop-decode failed";
+}
+
+sub sort_qif {
+    no warnings 'uninitialized';
+    my ($in, $out) = @_;
+    local $/ = "\n\n";
+    open F, $in or die "cannot open $in for reading: $!";
+    my @chunks = map $$_[1],
+		 sort { $$a[0] <=> $$b[0] }
+		 map { /^#\s*stream\s+(\d+)/; [ $1, $_ ] }
+		 <F>;
+    close F;
+    for (@chunks) {
+        s/^#.*\n//mg;
+    }
+    open F, ">", $out or die "cannot open $out for writing: $!";
+    print F @chunks;
+    close F;
+}
+
+sort_qif($qif_file, "$qif_file.canonical");
+sort_qif($resulting_qif_file, "$resulting_qif_file.canonical");
+
+exit compare "$qif_file.canonical", "$resulting_qif_file.canonical";

data/ls-qpack/test/run-scenario.sh

@@ -0,0 +1,68 @@
+#!/bin/bash
+#
+# Script to run a scenario file.  A scenario file contains encoder parameters
+# as well as a list of headers in QIF format.  The headers are encoded and
+# the output is then decoded and compared to the original.
+
+set -x
+set -e
+
+for NEED in interop-encode interop-decode sort-qif.pl; do
+    type $NEED
+    if [ $? -ne 0 ]; then
+        echo $NEED is not in $PATH 1>&2
+        exit 1
+    fi
+done
+
+function cleanup {
+    rm -vf $QIF_FILE
+    rm -vf $BIN_FILE
+    rm -vf $RESULTING_QIF_FILE
+    rm -vf $ENCODE_LOG
+    rmdir $DIR
+}
+
+if [ -z "$DO_CLEANUP" -o "$DO_CLEANUP" != 0 ]; then
+    trap cleanup EXIT
+fi
+
+RECIPE=$1
+
+source $RECIPE
+
+DIR=/tmp/recipe-out-$$$RANDOM
+ENCODE_LOG=$DIR/encode.log
+QIF_FILE=$DIR/qif
+BIN_FILE=$DIR/out
+RESULTING_QIF_FILE=$DIR/qif-result
+mkdir -p $DIR
+
+if [ "$AGGRESSIVE" = 1 ]; then
+    ENCODE_ARGS="$ENCODE_ARGS -A"
+fi
+
+if [ "$IMMEDIATE_ACK" = 1 ]; then
+    ENCODE_ARGS="$ENCODE_ARGS -a 1"
+fi
+
+if [ "$ANNOTATIONS" = 1 ]; then
+    ENCODE_ARGS="$ENCODE_ARGS -n"
+fi
+
+if [ -n "$RISKED_STREAMS" ]; then
+    ENCODE_ARGS="$ENCODE_ARGS -s $RISKED_STREAMS"
+    DECODE_ARGS="$DECODE_ARGS -s $RISKED_STREAMS"
+fi
+
+if [ -n "$TABLE_SIZE" ]; then
+    ENCODE_ARGS="$ENCODE_ARGS -t $TABLE_SIZE"
+    DECODE_ARGS="$DECODE_ARGS -t $TABLE_SIZE"
+fi
+
+echo -e "$QIF"\\n > $QIF_FILE
+
+interop-encode $ENCODE_ARGS -i $QIF_FILE -o $BIN_FILE 2>$ENCODE_LOG
+interop-decode $DECODE_ARGS -i $BIN_FILE -o $RESULTING_QIF_FILE
+diff <(sort-qif.pl --strip $QIF_FILE) \
+                <(sort-qif.pl --strip $RESULTING_QIF_FILE)

data/ls-qpack/test/scenarios/0.95-reset.sce

@@ -0,0 +1,10 @@
+TABLE_SIZE=256
+AGGRESSIVE=1
+RISKED_STREAMS=0
+QIF=$(cat<<'EOQ'
+dude	nude
+dude	nude
+dude	where is my car?
+
+EOQ
+)

data/ls-qpack/test/scenarios/cancel-stream.sce

@@ -0,0 +1,22 @@
+TABLE_SIZE=256
+ANNOTATIONS=1
+QIF=$(cat<<'EOQ'
+dude	nude
+dude	nude
+## c 1
+dude	where is my car?
+
+one	fish
+two	fish
+## c 2
+red	fish
+blue	fish
+
+black	fish
+blue	fish
+## c 3
+old	fish
+new	fish
+
+EOQ
+)

data/ls-qpack/test/scenarios/drain-2.sce

@@ -0,0 +1,37 @@
+TABLE_SIZE=512
+ANNOTATIONS=1
+AGGRESSIVE=0
+RISKED_STREAMS=0
+IMMEDIATE_ACK=0
+QIF=$(cat<<'EOQ'
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+spire	must be repaired
+sainte-chapelle	is known as the kingdom of light
+notre	dame translates our to lady of paris
+iconography	poor peoples book
+## s 2
+
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+
+victor	hugo wrote the hunchback
+archdiocese	of paris
+twelve	million people visit annually
+coronation	of emperor napoleon
+most	famous gothic cathedral
+
+victor	hugo wrote the hunchback
+archdiocese	of paris
+twelve	million people visit annually
+coronation	of emperor napoleon
+most	famous gothic cathedral
+
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+
+EOQ
+)

data/ls-qpack/test/scenarios/drain.sce

@@ -0,0 +1,37 @@
+TABLE_SIZE=512
+ANNOTATIONS=1
+AGGRESSIVE=0
+RISKED_STREAMS=0
+IMMEDIATE_ACK=0
+QIF=$(cat<<'EOQ'
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+spire	must be repaired
+sainte-chapelle	is known as the kingdom of light
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+## s 2
+
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+
+victor	hugo wrote the hunchback
+archdiocese	of paris
+twelve	million people visit annually
+coronation	of emperor napoleon
+most	famous gothic cathedral
+
+victor	hugo wrote the hunchback
+archdiocese	of paris
+twelve	million people visit annually
+coronation	of emperor napoleon
+most	famous gothic cathedral
+
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+
+notre	dame translates to our lady of paris
+iconography	poor peoples book
+
+EOQ
+)

data/ls-qpack/test/scenarios/end-dst-2.sce

@@ -0,0 +1,14 @@
+# This scenario is designed to reach the 'case HUFF_DEC_END_DST'
+# in lsqpack_dec_enc_in().
+TABLE_SIZE=256
+AGGRESSIVE=0
+RISKED_STREAMS=0
+QIF=$(cat<<'EOQ'
+aaaaaaaaaaaaaaaaaaaaaaaaa	aaaa
+bbbbbbbbbbbbbbbbbbbbbbbbb	bbbb
+
+aaaaaaaaaaaaaaaaaaaaaaaaa	aaaa
+bbbbbbbbbbbbbbbbbbbbbbbbb	bbbb
+
+EOQ
+)

data/ls-qpack/test/scenarios/end-dst.sce

@@ -0,0 +1,14 @@
+# This scenario is designed to reach the 'case HUFF_DEC_END_DST'
+# in parse_header_data() when Huffman encoding is turned on.
+TABLE_SIZE=256
+AGGRESSIVE=1
+RISKED_STREAMS=1
+QIF=$(cat<<'EOQ'
+aaaa	aaa
+aaaa	aaaaa
+aaaa	aaaaaaaa
+aaaa	aaaaaaaaaaaaa
+aaaa	aaaaaaaaaaaaaaaaaaaaa
+
+EOQ
+)

data/ls-qpack/test/scenarios/incl-name.sce

@@ -0,0 +1,13 @@
+# This scenario is designed to reach 'case DATA_STATE_READ_LFONR_NAME_PLAIN'
+# in parse_header_data(). It contains header names that are be too small
+# for Huffman coding.
+TABLE_SIZE=256
+AGGRESSIVE=1
+RISKED_STREAMS=0
+QIF=$(cat<<'EOQ'
+yo	I
+no	do not
+se	know
+
+EOQ
+)

data/ls-qpack/test/scenarios/multi-byte-int-dyn-ref-1.sce

@@ -0,0 +1,110 @@
+# This scenario is designed to reach the `case EEA_INS_NAMEREF_DYNAMIC`
+# in the `lsqpack_enc_encode` function. It is intended to fail the integer
+# encoding due to buffer length. To trigger this case, many names must be
+# inserted into the dynamic table so that the integer encoding requires
+# more than one byte.
+TABLE_SIZE=16384
+AGGRESSIVE=1
+IMMEDIATE_ACK=0
+RISKED_STREAMS=1000
+QIF=$(cat<<'EOQ'
+aaaaaaaaaaaaa	aaaaaaaaaaaaaaaaaaaaaaaaaa
+bbbbbbbbbbbbb	bbbbbbbbbbbbbbbbbbbbbbbbbb
+ccccccccccccc	cccccccccccccccccccccccccc
+ddddddddddddd	dddddddddddddddddddddddddd
+eeeeeeeeeeeee	eeeeeeeeeeeeeeeeeeeeeeeeee
+fffffffffffff	ffffffffffffffffffffffffff
+ggggggggggggg	gggggggggggggggggggggggggg
+aaaa	oneeeeeeeee
+bbbb	oneeeeeeeee
+cccc	oneeeeeeeee
+dddd	oneeeeeeeee
+eeee	oneeeeeeeee
+ffff	oneeeeeeeee
+gggg	oneeeeeeeee
+hhhh	oneeeeeeeee
+iiii	oneeeeeeeee
+jjjj	oneeeeeeeee
+kkkk	oneeeeeeeee
+llll	oneeeeeeeee
+mmmm	oneeeeeeeee
+nnnn	oneeeeeeeee
+oooo	oneeeeeeeee
+pppp	oneeeeeeeee
+qqqq	oneeeeeeeee
+rrrr	oneeeeeeeee
+ssss	oneeeeeeeee
+tttt	oneeeeeeeee
+uuuu	oneeeeeeeee
+vvvv	oneeeeeeeee
+wwww	oneeeeeeeee
+xxxx	oneeeeeeeee
+yyyy	oneeeeeeeee
+zzzz	oneeeeeeeee
+aabb	oneeeeeeeee
+bbcc	oneeeeeeeee
+ccdd	oneeeeeeeee
+ddee	oneeeeeeeee
+eeff	oneeeeeeeee
+ffgg	oneeeeeeeee
+gghh	oneeeeeeeee
+hhii	oneeeeeeeee
+iijj	oneeeeeeeee
+jjkk	oneeeeeeeee
+kkll	oneeeeeeeee
+llmm	oneeeeeeeee
+mmnn	oneeeeeeeee
+nnoo	oneeeeeeeee
+oopp	oneeeeeeeee
+ppqq	oneeeeeeeee
+qqrr	oneeeeeeeee
+rrss	oneeeeeeeee
+sstt	oneeeeeeeee
+ttuu	oneeeeeeeee
+uuvv	oneeeeeeeee
+vvww	oneeeeeeeee
+wwxx	oneeeeeeeee
+xxyy	oneeeeeeeee
+yyzz	oneeeeeeeee
+
+bbbb	two
+cccc	two
+dddd	two
+eeee	two
+ffff	two
+gggg	two
+hhhh	two
+yyyy	two
+zzzz	two
+aabb	two
+bbcc	two
+ccdd	two
+ddee	two
+eeff	two
+ffgg	two
+gghh	two
+hhii	two
+iijj	two
+jjkk	two
+kkll	two
+llmm	two
+mmnn	two
+nnoo	two
+oopp	two
+ppqq	two
+qqrr	two
+rrss	two
+sstt	two
+ttuu	two
+uuvv	two
+vvww	two
+wwxx	two
+xxyy	two
+yyzz	two
+aaaa	two
+
+aaaa	three
+bbbb	three
+
+EOQ
+)