[lwip-devel] [bug #59875] Conflicting documentation for pbuf_free handling of chains

[Christopher Head]

URL:
  <https://savannah.nongnu.org/bugs/?59875>

                 Summary: Conflicting documentation for pbuf_free handling of
chains
                 Project: lwIP - A Lightweight TCP/IP stack
            Submitted by: hawk777
            Submitted on: Thu 14 Jan 2021 10:22:05 PM UTC
                Category: Documentation
                Severity: 3 - Normal
              Item Group: None
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None
            lwIP version: 2.1.0

    _______________________________________________________

Details:

Looking at the documentation of pbuf_free at
<http://www.nongnu.org/lwip/2_1_x/group__pbuf.html#gab0dd696fb4b6bc65e548944584f1738b>.

The first sentence says this:

> Dereference a pbuf chain or queue and deallocate any no-longer-used pbufs at
the head of this chain or queue.

The first line of the notes section says this:

> MUST NOT be called on a packet queue (Not verified to work yet). 

So does it or doesn’t it work on queues? One sentence says it does and the
other says it might not. In practice, as written right now, the only thing
pbuf_free cares about is the next pointers, reference counts, flags, and type,
so it would work fine with chains, queues, and even sub-packet-sized slices
where tot_len is greater than the sum of len values.




    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/bugs/?59875>

_______________________________________________
  Message sent via Savannah
  https://savannah.nongnu.org/