Does It Spin? On the Adoption and Use of QUIC's Spin Bit

This repository contains the extracted raw spin bit values as used in our paper as well as golang scripts for analyzing them.

## Publication

* Ike Kunze, Constantin Sander, and Klaus Wehrle: *Does It Spin? On the Adoption and Use of QUIC’s Spin Bit. In Proceedings of the ACM Internet Measurement Conference 2023 (IMC '23), 2023.

If you use any portion of our work, please consider citing our publication.

```
@Inproceedings { 2023-kunze-spin-bit-in-the-wild,
   author = {Kunze, Ike and Sander, Constantin and Wehrle, Klaus},
   title = {Does It Spin? On the Adoption and Use of QUIC’s Spin Bit},
   booktitle = {Proceedings of the Internet Measurement Conference (IMC '23)},
   year = {2023},
   month = {10},
   publisher = {ACM}, 
   doi = {TBD}
}
```

## Use

1. Decompress the dataset:

For using the data set, first untar the data.

```
tar -xzf extracted-spin-bit-values.tar.gz

```

1.1 Data format:

The files contained in the data set each contain line-wise dictionaries with the following content:

- QlogRTTs: RTTs as provided by the QUIC stack via qlog

- SentSpinBits: all packets sent out by our client, each containing a timestamp, the spinbit value (Val) and the packet number (PN)

- RecvSpinBits: all packets received by our client, each containing a timestamp, the spinbit value (Val) and the packet number (PN)

 2. Compile golang module:

We use a golang module for analyzing the data.
Compile the module using

```
go build -o analyze-spinbit analyze-spinbit.go
```

3. Analyze individual files: 

You can analyze the files by running the compiled `analyze-spinbit` program on individual files.

```
cat FILE_TO_ANALYZE | ./analyze-spinbit -buffer 1073741824 -logfile LOGFILENAME -outputfilebasename OUTPUTFILENAME --batchsize 1000000 --outputsuffix json
```

4. Output format:

Line-wise dictionaries containing:

- which spin mode was detected

- number of considered packets

- real RTTs based on QUIC stack estimates

- minimum RTT based on QUIC stack estimates

- RTTs as calculated via the spin bit

- RTTs as calculated via the spin bit when reordering the packets using the packet numbers