MINOR: quic: Add traces for qc_frm_free()

Useful to diagnose memory leak issues in relation with the QUIC frame objects.

diff --git a/include/haproxy/quic_frame.h b/include/haproxy/quic_frame.h
index 95df7db1765b0e49e1b047709e47fef11c1b6a6c..5ff432409715c1fb9d12bc0418574b76cb06d425 100644 (file)
--- a/include/haproxy/quic_frame.h
+++ b/include/haproxy/quic_frame.h
@@ -254,28 +254,9 @@ static inline struct quic_frame *qc_frm_dup(struct quic_frame *origin)
        return frm;
 }
 
+void qc_frm_free(struct quic_conn *qc, struct quic_frame **frm);
 void qc_frm_unref(struct quic_frame *frm, struct quic_conn *qc);
 
-/* Free a <frm> quic_frame. Remove it from parent element if still attached. */
-static inline void qc_frm_free(struct quic_frame **frm)
-{
-
-       /* Caller must ensure that no other frame points to <frm>. Use
-        * qc_frm_unref() to handle this properly.
-        */
-       BUG_ON(!LIST_ISEMPTY(&((*frm)->reflist)));
-       BUG_ON(LIST_INLIST(&((*frm)->ref)));
-
-       /* TODO simplify frame deallocation. In some code paths, we must
-        * manually call this LIST_DEL_INIT before using
-        * quic_tx_packet_refdec() and freeing the frame.
-        */
-       LIST_DEL_INIT(&((*frm)->list));
-
-       pool_free(pool_head_quic_frame, *frm);
-       *frm = NULL;
-}
-
 /* Move forward <strm> STREAM frame by <data> bytes. */
 static inline void qc_stream_frm_mv_fwd(struct quic_frame *frm, uint64_t data)
 {

diff --git a/include/haproxy/quic_tls.h b/include/haproxy/quic_tls.h
index be3851503dc44608cdef60e450aa8be777792cc0..305161583d2b412459532f8a1937c4667bc0c6e6 100644 (file)
--- a/include/haproxy/quic_tls.h
+++ b/include/haproxy/quic_tls.h
@@ -481,7 +481,7 @@ static inline void quic_pktns_tx_pkts_release(struct quic_pktns *pktns, struct q
                        qc_frm_unref(frm, qc);
                        LIST_DEL_INIT(&frm->list);
                        quic_tx_packet_refdec(frm->pkt);
-                       qc_frm_free(&frm);
+                       qc_frm_free(qc, &frm);
                }
                eb64_delete(&pkt->pn_node);
                quic_tx_packet_refdec(pkt);

diff --git a/src/mux_quic.c b/src/mux_quic.c
index f89d4502f7843f186871f6a11e87a5f3ca29c451..2c400b446f18fda814cd02e9f5c3a04b66db7ac6 100644 (file)
--- a/src/mux_quic.c
+++ b/src/mux_quic.c
@@ -1820,7 +1820,7 @@ static int qcs_send_reset(struct qcs *qcs)
        LIST_APPEND(&frms, &frm->list);
        if (qcc_send_frames(qcs->qcc, &frms)) {
                if (!LIST_ISEMPTY(&frms))
-                       qc_frm_free(&frm);
+                       qc_frm_free(qcs->qcc->conn->handle.qc, &frm);
                TRACE_DEVEL("cannot send RESET_STREAM", QMUX_EV_QCS_SEND, qcs->qcc->conn, qcs);
                return 1;
        }
@@ -1871,7 +1871,7 @@ static int qcs_send_stop_sending(struct qcs *qcs)
        LIST_APPEND(&frms, &frm->list);
        if (qcc_send_frames(qcs->qcc, &frms)) {
                if (!LIST_ISEMPTY(&frms))
-                       qc_frm_free(&frm);
+                       qc_frm_free(qcc->conn->handle.qc, &frm);
                TRACE_DEVEL("cannot send STOP_SENDING", QMUX_EV_QCS_SEND, qcs->qcc->conn, qcs);
                return 1;
        }
@@ -2121,7 +2121,7 @@ static int qcc_io_send(struct qcc *qcc)
                struct quic_frame *frm, *frm2;
 
                list_for_each_entry_safe(frm, frm2, &frms, list)
-                       qc_frm_free(&frm);
+                       qc_frm_free(qcc->conn->handle.qc, &frm);
        }
 
        /* Re-insert on-error QCS at the end of the send-list. */
@@ -2390,7 +2390,7 @@ static void qcc_release(struct qcc *qcc)
 
        while (!LIST_ISEMPTY(&qcc->lfctl.frms)) {
                struct quic_frame *frm = LIST_ELEM(qcc->lfctl.frms.n, struct quic_frame *, list);
-               qc_frm_free(&frm);
+               qc_frm_free(qcc->conn->handle.qc, &frm);
        }
 
        if (qcc->app_ops && qcc->app_ops->release)

diff --git a/src/quic_conn.c b/src/quic_conn.c
index d12e2b44f7e4d27241882cd167c1bd237f59abf6..a652c0f90cfb74143e10eaee4d2b5fc970b62145 100644 (file)
--- a/src/quic_conn.c
+++ b/src/quic_conn.c
@@ -1699,7 +1699,7 @@ void qc_release_frm(struct quic_conn *qc, struct quic_frame *frm)
                        TRACE_DEVEL("freeing unsent frame",
                                    QUIC_EV_CONN_PRSAFRM, qc, f);
                        LIST_DEL_INIT(&f->ref);
-                       qc_frm_free(&f);
+                       qc_frm_free(qc, &f);
                }
        }
        LIST_DEL_INIT(&frm->list);
@@ -1707,7 +1707,7 @@ void qc_release_frm(struct quic_conn *qc, struct quic_frame *frm)
        quic_tx_packet_refdec(frm->pkt);
        TRACE_DEVEL("freeing frame from packet",
                    QUIC_EV_CONN_PRSAFRM, qc, frm, &pn);
-       qc_frm_free(&frm);
+       qc_frm_free(qc, &frm);
 
        TRACE_LEAVE(QUIC_EV_CONN_PRSAFRM, qc);
 }
@@ -1935,7 +1935,7 @@ static inline int qc_requeue_nacked_pkt_tx_frms(struct quic_conn *qc,
                                TRACE_DEVEL("released stream", QUIC_EV_CONN_PRSAFRM, qc, frm);
                                TRACE_DEVEL("freeing frame from packet", QUIC_EV_CONN_PRSAFRM,
                                            qc, frm, &pn);
-                               qc_frm_free(&frm);
+                               qc_frm_free(qc, &frm);
                                continue;
                        }
 
@@ -1944,7 +1944,7 @@ static inline int qc_requeue_nacked_pkt_tx_frms(struct quic_conn *qc,
                        if (strm_frm->offset.key + strm_frm->len <= stream_desc->ack_offset) {
                                TRACE_DEVEL("ignored frame in already acked range",
                                            QUIC_EV_CONN_PRSAFRM, qc, frm);
-                               qc_frm_free(&frm);
+                               qc_frm_free(qc, &frm);
                                continue;
                        }
                        else if (strm_frm->offset.key < stream_desc->ack_offset) {
@@ -1967,7 +1967,7 @@ static inline int qc_requeue_nacked_pkt_tx_frms(struct quic_conn *qc,
                                    qc, frm, &pn);
                        if (frm->origin)
                                LIST_DEL_INIT(&frm->ref);
-                       qc_frm_free(&frm);
+                       qc_frm_free(qc, &frm);
                        continue;
                }
 
@@ -1975,7 +1975,7 @@ static inline int qc_requeue_nacked_pkt_tx_frms(struct quic_conn *qc,
                        TRACE_DEVEL("already acked frame", QUIC_EV_CONN_PRSAFRM, qc, frm);
                        TRACE_DEVEL("freeing frame from packet", QUIC_EV_CONN_PRSAFRM,
                                    qc, frm, &pn);
-                       qc_frm_free(&frm);
+                       qc_frm_free(qc, &frm);
                }
                else {
                        if (++frm->loss_count >= global.tune.quic_max_frame_loss) {
@@ -2010,7 +2010,7 @@ static inline void free_quic_tx_packet(struct quic_conn *qc,
                goto leave;
 
        list_for_each_entry_safe(frm, frmbak, &pkt->frms, list)
-               qc_frm_free(&frm);
+               qc_frm_free(qc, &frm);
        pool_free(pool_head_quic_tx_packet, pkt);
 
  leave:
@@ -2126,7 +2126,7 @@ static inline void qc_release_pktns_frms(struct quic_conn *qc,
        TRACE_ENTER(QUIC_EV_CONN_PHPKTS, qc);
 
        list_for_each_entry_safe(frm, frmbak, &pktns->tx.frms, list)
-               qc_frm_free(&frm);
+               qc_frm_free(qc, &frm);
 
        TRACE_LEAVE(QUIC_EV_CONN_PHPKTS, qc);
 }
@@ -2871,7 +2871,7 @@ static int qc_h3_request_reject(struct quic_conn *qc, uint64_t id)
        rs = qc_frm_alloc(QUIC_FT_RESET_STREAM);
        if (!rs) {
                TRACE_ERROR("failed to allocate quic_frame", QUIC_EV_CONN_PRSHPKT, qc);
-               qc_frm_free(&ss);
+               qc_frm_free(qc, &ss);
                goto out;
        }
 
@@ -3546,30 +3546,31 @@ static int qc_prep_app_pkts(struct quic_conn *qc, struct buffer *buf,
 /* Free all frames in <l> list. In addition also remove all these frames
  * from the original ones if they are the results of duplications.
  */
-static inline void qc_free_frm_list(struct list *l)
+static inline void qc_free_frm_list(struct quic_conn *qc, struct list *l)
 {
        struct quic_frame *frm, *frmbak;
 
        list_for_each_entry_safe(frm, frmbak, l, list) {
                LIST_DEL_INIT(&frm->ref);
-               qc_frm_free(&frm);
+               qc_frm_free(qc, &frm);
        }
 }
 
 /* Free <pkt> TX packet and all the packets coalesced to it. */
-static inline void qc_free_tx_coalesced_pkts(struct quic_tx_packet *p)
+static inline void qc_free_tx_coalesced_pkts(struct quic_conn *qc,
+                                             struct quic_tx_packet *p)
 {
        struct quic_tx_packet *pkt, *nxt_pkt;
 
        for (pkt = p; pkt; pkt = nxt_pkt) {
-               qc_free_frm_list(&pkt->frms);
+               qc_free_frm_list(qc, &pkt->frms);
                nxt_pkt = pkt->next;
                pool_free(pool_head_quic_tx_packet, pkt);
        }
 }
 
 /* Purge <buf> TX buffer from its prepare packets. */
-static void qc_purge_tx_buf(struct buffer *buf)
+static void qc_purge_tx_buf(struct quic_conn *qc, struct buffer *buf)
 {
        while (b_contig_data(buf, 0)) {
                uint16_t dglen;
@@ -3578,7 +3579,7 @@ static void qc_purge_tx_buf(struct buffer *buf)
 
                dglen = read_u16(b_head(buf));
                pkt = read_ptr(b_head(buf) + sizeof dglen);
-               qc_free_tx_coalesced_pkts(pkt);
+               qc_free_tx_coalesced_pkts(qc, pkt);
                b_del(buf, dglen + headlen);
        }
 
@@ -3638,9 +3639,9 @@ int qc_send_ppkts(struct buffer *buf, struct ssl_sock_ctx *ctx)
                        if (ret < 0) {
                                TRACE_ERROR("sendto fatal error", QUIC_EV_CONN_SPPKTS, qc, first_pkt);
                                qc_kill_conn(qc);
-                               qc_free_tx_coalesced_pkts(first_pkt);
+                               qc_free_tx_coalesced_pkts(qc, first_pkt);
                                b_del(buf, dglen + headlen);
-                               qc_purge_tx_buf(buf);
+                               qc_purge_tx_buf(qc, buf);
                                goto leave;
                        }
                        else if (!ret) {
@@ -3983,7 +3984,7 @@ static int quic_build_post_handshake_frames(struct quic_conn *qc)
 
                conn_id = new_quic_cid(&qc->cids, qc, NULL, NULL);
                if (!conn_id) {
-                       qc_frm_free(&frm);
+                       qc_frm_free(qc, &frm);
                        TRACE_ERROR("CID allocation error", QUIC_EV_CONN_IO_CB, qc);
                        goto err;
                }
@@ -4008,7 +4009,7 @@ static int quic_build_post_handshake_frames(struct quic_conn *qc)
  err:
        /* free the frames */
        list_for_each_entry_safe(frm, frmbak, &frm_list, list)
-               qc_frm_free(&frm);
+               qc_frm_free(qc, &frm);
 
        /* The first CID sequence number value used to allocated CIDs by this function is 1,
         * 0 being the sequence number of the CID for this connection.
@@ -5004,7 +5005,7 @@ static int qc_dgrams_retransmit(struct quic_conn *qc)
                        if (!LIST_ISEMPTY(&frms1)) {
                                apktns->tx.pto_probe = 1;
                                if (!qc_send_app_probing(qc, &frms1)) {
-                                       qc_free_frm_list(&frms2);
+                                       qc_free_frm_list(qc, &frms2);
                                        goto leave;
                                }
 
@@ -7575,7 +7576,7 @@ static inline int qc_build_frms(struct list *outlist, struct list *inlist,
                                node = eb64_lookup(&qc->streams_by_id, strm_frm->id);
                                if (!node) {
                                        TRACE_DEVEL("released stream", QUIC_EV_CONN_PRSAFRM, qc, cf);
-                                       qc_frm_free(&cf);
+                                       qc_frm_free(qc, &cf);
                                        continue;
                                }
 
@@ -7583,7 +7584,7 @@ static inline int qc_build_frms(struct list *outlist, struct list *inlist,
                                if (strm_frm->offset.key + strm_frm->len <= stream_desc->ack_offset) {
                                        TRACE_DEVEL("ignored frame frame in already acked range",
                                                    QUIC_EV_CONN_PRSAFRM, qc, cf);
-                                       qc_frm_free(&cf);
+                                       qc_frm_free(qc, &cf);
                                        continue;
                                }
                                else if (strm_frm->offset.key < stream_desc->ack_offset) {

diff --git a/src/quic_frame.c b/src/quic_frame.c
index 6f93ddf8d0efcf4d673f63d38cbbcc7dcf904ad7..98b7af0a93c67d2782187f49b4681718a2fef29e 100644 (file)
--- a/src/quic_frame.c
+++ b/src/quic_frame.c
@@ -1182,7 +1182,7 @@ void qc_frm_unref(struct quic_frame *frm, struct quic_conn *qc)
 {
        struct quic_frame *f, *tmp;
 
-       TRACE_ENTER(QUIC_EV_CONN_PRSAFRM, qc);
+       TRACE_ENTER(QUIC_EV_CONN_PRSAFRM, qc, frm);
 
        list_for_each_entry_safe(f, tmp, &frm->reflist, ref) {
                f->origin = NULL;
@@ -1199,3 +1199,25 @@ void qc_frm_unref(struct quic_frame *frm, struct quic_conn *qc)
 
        TRACE_LEAVE(QUIC_EV_CONN_PRSAFRM, qc);
 }
+
+/* Free a <frm> quic_frame. Remove it from parent element if still attached. */
+void qc_frm_free(struct quic_conn *qc, struct quic_frame **frm)
+{
+
+       TRACE_ENTER(QUIC_EV_CONN_PRSAFRM, qc, *frm);
+       /* Caller must ensure that no other frame points to <frm>. Use
+        * qc_frm_unref() to handle this properly.
+        */
+       BUG_ON(!LIST_ISEMPTY(&((*frm)->reflist)));
+       BUG_ON(LIST_INLIST(&((*frm)->ref)));
+
+       /* TODO simplify frame deallocation. In some code paths, we must
+        * manually call this LIST_DEL_INIT before using
+        * quic_tx_packet_refdec() and freeing the frame.
+        */
+       LIST_DEL_INIT(&((*frm)->list));
+
+       pool_free(pool_head_quic_frame, *frm);
+       *frm = NULL;
+       TRACE_LEAVE(QUIC_EV_CONN_PRSAFRM, qc);
+}