From 14e3ac47c0c3f9034db064d6d598cbaeab1e7582 Mon Sep 17 00:00:00 2001
From: huitema <huitema@huitema.net>
Date: Mon, 9 Sep 2024 21:24:09 -0700
Subject: [PATCH] Flags for testing BBR extensions

---
 picoquic/bbr.c               | 19 ++++++++++++++++---
 picoquic/picoquic.h          | 18 ++++++++++++++++++
 picoquic/picoquic_internal.h |  5 +++++
 picoquic/quicctx.c           |  6 ++++++
 4 files changed, 45 insertions(+), 3 deletions(-)

diff --git a/picoquic/bbr.c b/picoquic/bbr.c
index 41929d1ab..e7539d703 100644
--- a/picoquic/bbr.c
+++ b/picoquic/bbr.c
@@ -25,6 +25,14 @@
 #include "cc_common.h"
 #include "picoquic_utils.h"
 
+#ifdef BBRExperiment
+#define BBRExpGate(ctx, test, action) { if (ctx->exp_flags.test) action; }
+#define BBRExpTest(ctx, test) ( (ctx)->exp_flags.test )
+#else
+#define BBRExpGate(ctx, test, action) {}
+#define BBRExpTest(ctx, test) (1)
+#endif
+
 #define RTTJitterBuffer On
 #define RTTJitterBufferStartup On
 #define RTTJitterBufferProbe On
@@ -251,6 +259,10 @@ typedef struct st_picoquic_bbr_state_t {
     /* Experimental extensions, may or maynot be a good idea. */
     uint64_t wifi_shadow_rtt; /* Shadow RTT used for wifi connections. */
     double quantum_ratio; /* allow application to use a different default than 0.1% of bandwidth (or 1ms of traffic) */
+#ifdef BBRExperiment
+    /* Control flags for BBR improvements */
+    bbr_exp exp_flags;
+#endif
 
 } picoquic_bbr_state_t;
 
@@ -669,7 +681,7 @@ static void BBROnExitRecovery(picoquic_bbr_state_t* bbr_state, picoquic_path_t*
         bbr_state->recovery_packet_number = UINT64_MAX;
         bbr_state->packet_conservation = 0;
 
-        if (bbr_state->is_pto_recovery) {
+        if (bbr_state->is_pto_recovery && BBRExpTest(bbr_state, do_handle_suspension)) {
             /* TODO:
              * we should try to enter startup with a high enough BW. However, 
              * simple attempts to restore the BW parameters have proven ineffective.
@@ -1602,7 +1614,7 @@ static void BBRStartProbeBW_DOWN(picoquic_bbr_state_t* bbr_state, picoquic_path_
     bbr_state->cwnd_gain = BBRProbeBwDownCwndGain;   /* maintain cwnd */
     BBRResetCongestionSignals(bbr_state);
     bbr_state->bw_probe_up_cnt = UINT32_MAX; /* not growing inflight_hi */
-    if (bbr_state->probe_probe_bw_quickly) {
+    if (bbr_state->probe_probe_bw_quickly && BBRExpTest(bbr_state, do_rapid_start)) {
         BBRPickProbeWaitEarly(bbr_state);
     }
     else {
@@ -1847,7 +1859,7 @@ static void BBRCheckStartupDone(picoquic_bbr_state_t* bbr_state,
         BBRCheckStartupFullBandwidth(bbr_state, rs);
         BBRCheckStartupHighLoss(bbr_state, path_x, rs);
 #ifdef RTTJitterBufferStartup
-        if (IsRTTTooHigh(bbr_state)) {
+        if (IsRTTTooHigh(bbr_state) && BBRExpTest(bbr_state, do_early_exit)) {
             bbr_state->filled_pipe = 1;
         }
 #endif
@@ -2232,6 +2244,7 @@ static void picoquic_bbr_notify(
             break;
         case picoquic_congestion_notification_lost_feedback:
             /* Feedback has been lost. It will be restored at the next notification. */
+            BBRExpGate(bbr_state, do_control_lost, break);
             BBREnterLostFeedback(bbr_state, path_x);
             break;
         case picoquic_congestion_notification_rtt_measurement:
diff --git a/picoquic/picoquic.h b/picoquic/picoquic.h
index cd7e83a42..04187e5f8 100644
--- a/picoquic/picoquic.h
+++ b/picoquic/picoquic.h
@@ -1528,6 +1528,24 @@ void picoquic_set_default_wifi_shadow_rtt(picoquic_quic_t* quic, uint64_t wifi_s
 */
 void picoquic_set_default_bbr_quantum_ratio(picoquic_quic_t* quic, double quantum_ratio);
 
+/* Temporary code, do define a set of BBR flags that
+* turn on and off individual extensions. We want to use that
+* to do "before/after" measurements.
+ */
+#define BBRExperiment on
+#ifdef BBRExperiment
+/* Control flags for BBR improvements */
+typedef struct st_bbr_exp {
+    unsigned int do_early_exit : 1;
+    unsigned int do_rapid_start : 1;
+    unsigned int do_handle_suspension : 1;
+    unsigned int do_control_lost : 1;
+    unsigned int do_exit_probeBW_up_on_delay : 1;
+    unsigned int do_enter_probeBW_up_on_streams : 1;
+} bbr_exp;
+
+void picoquic_set_bbr_exp(picoquic_quic_t * quic, bbr_exp* exp);
+#endif
 /* The experimental API 'picoquic_set_priority_limit_for_bypass' 
 * instruct the stack to send the high priority streams or datagrams
 * immediately, even if congestion control would normally prevent it.
diff --git a/picoquic/picoquic_internal.h b/picoquic/picoquic_internal.h
index 810c11f0b..28e00a03a 100644
--- a/picoquic/picoquic_internal.h
+++ b/picoquic/picoquic_internal.h
@@ -735,6 +735,11 @@ typedef struct st_picoquic_quic_t {
     struct st_picoquic_unified_logging_t* qlog_fns;
     picoquic_performance_log_fn perflog_fn;
     void* v_perflog_ctx;
+
+#ifdef BBRExperiment
+    bbr_exp bbr_exp_flags;
+#endif
+
 } picoquic_quic_t;
 
 picoquic_packet_context_enum picoquic_context_from_epoch(int epoch);
diff --git a/picoquic/quicctx.c b/picoquic/quicctx.c
index 7f9e0b3b7..8ba8d372d 100644
--- a/picoquic/quicctx.c
+++ b/picoquic/quicctx.c
@@ -4925,6 +4925,12 @@ void picoquic_set_default_bbr_quantum_ratio(picoquic_quic_t* quic, double quantu
     quic->bbr_quantum_ratio = quantum_ratio;
 }
 
+#ifdef BBRExperiment
+void picoquic_set_bbr_exp(picoquic_quic_t* quic, bbr_exp* exp)
+{
+    quic->bbr_exp_flags = *exp;
+}
+#endif
 void picoquic_set_priority_limit_for_bypass(picoquic_cnx_t* cnx, uint8_t priority_limit)
 {
     cnx->priority_limit_for_bypass = priority_limit;