Skip to content

Commit 39f1a9f

Browse files
committed
Update README and configs
1 parent c90ae9a commit 39f1a9f

14 files changed

+52
-21
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ cargo 1.74.0
4949
Next, build from sources using:
5050
```bash
5151
❯❯ cargo build --release
52+
53+
...
54+
Finished `release` profile [optimized] target(s) in ...s
5255
```
5356

5457
## Running
@@ -182,13 +185,13 @@ called `Result::unwrap()` on an `Err` value: Disconnected
182185
```
183186
which is caused by the RPC batch sizes.
184187

185-
To fix this reduce the batch sizes of either the reports or the FLPs (or both).
186-
Note that this does not affect the online running time, but it affects the
187-
upload time from the `driver` to the Mastic servers.
188+
To fix this, reduce the batch sizes of either the reports or the FLPs (or both).
188189
```toml
189190
add_report_share_batch_size = 1000
190191
query_flp_batch_size = 100000
191192
```
193+
**Note:** this does not affect the online running time, but it affects the
194+
upload time from the `driver` to the Mastic servers.
192195

193196
## Disclaimer
194197

artifact/README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,10 @@ histogram as in the print message: `4 histogram buckets`. Each string e.g.,
248248
249249
Lastly, you can run both weighted heavy hitters and attribute based metrics with malicious clients by passing the `--malicious` and a percentage.
250250
251-
### Experiments
251+
252+
# Experiments
253+
254+
## Understanding the configuration files
252255
Our experiments can be reproduced by using our config files: https://github.com/TrustworthyComputing/mastic/tree/main/src/configs and the values provided in the paper.
253256
254257
For instance:
@@ -302,5 +305,30 @@ zipf_exponent = 1.03
302305
etc. These parameters are sufficient to reproduce all our results -- all our
303306
experiments in the paper specify the parameters used.
304307
308+
## Reproducing Experiments and Figures
305309
To reproduce our experiments, use the configs from the [configs](./configs/)
306310
directory and the scripts from the [plots](../plots/) directory.
311+
312+
## Troubleshooting
313+
As mentioned in the **Troubleshooting** section of the [README file](../README.md) file,
314+
Mastic relies on the [tarpc](https://github.com/google/tarpc) library which has
315+
a limit on the size of the RPC messages. As such, you might see an error similar
316+
to the following:
317+
```shell
318+
thread 'main' panicked at src/bin/driver.rs:335:
319+
called `Result::unwrap()` on an `Err` value: Disconnected
320+
```
321+
which is caused by the RPC batch sizes.
322+
323+
In case you run into this issue, you can fix this easily by reducing the batch
324+
sizes of either the reports or the FLPs (or both).
325+
```toml
326+
add_report_share_batch_size = 1000
327+
query_flp_batch_size = 100000
328+
```
329+
**Note:** this does not affect the online running time, but it affects the
330+
upload time from the `driver` to the Mastic servers. In other words, this does
331+
not change the experiments but will make setting up the experiments faster. For
332+
this reason, most of the provided configs use the default batch sizes, which may
333+
cause crashes with more clients or bits, but this can be simply resolved by
334+
reducing the batch sizes.

artifact/configs/figure-3/Mastic-m=10,n=128.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 9
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 100
9+
add_report_share_batch_size = 50
1010
query_flp_batch_size = 100000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

artifact/configs/figure-3/Mastic-m=10,n=256.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 9
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 100
9+
add_report_share_batch_size = 50
1010
query_flp_batch_size = 100000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

artifact/configs/figure-3/Mastic-m=10,n=64.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 9
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 100
9+
add_report_share_batch_size = 50
1010
query_flp_batch_size = 100000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

artifact/configs/figure-3/Mastic-m=30,n=128.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 29
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 100
9+
add_report_share_batch_size = 50
1010
query_flp_batch_size = 100000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

artifact/configs/figure-3/Mastic-m=30,n=256.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 29
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 100
9+
add_report_share_batch_size = 50
1010
query_flp_batch_size = 100000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

artifact/configs/figure-3/Mastic-m=30,n=64.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 29
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 100
9+
add_report_share_batch_size = 50
1010
query_flp_batch_size = 100000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

artifact/configs/figure-4/Mastic-m=30.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 29
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 100
10-
query_flp_batch_size = 100000
9+
add_report_share_batch_size = 50
10+
query_flp_batch_size = 10000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

artifact/configs/figure-6/Mastic-A=1.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hist_buckets = 100
66
server_0 = "0.0.0.0:8000"
77
server_1 = "0.0.0.0:8001"
88

9-
add_report_share_batch_size = 1000
10-
query_flp_batch_size = 100000
9+
add_report_share_batch_size = 500
10+
query_flp_batch_size = 10000
1111
zipf_unique_buckets = 1000
1212
zipf_exponent = 1.03

0 commit comments

Comments
 (0)