Skip to content

[PATCH v2] api: packet: clarify l2/l3/l4 pointer value when offset is too large #2325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MatiasElo merged 1 commit into from
Mar 30, 2026
+27 −6
Merged

[PATCH v2] api: packet: clarify l2/l3/l4 pointer value when offset is too large #2325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions include/odp/api/spec/packet.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1559,6 +1559,10 @@ void odp_packet_user_flag_set(odp_packet_t pkt, int val);
* bytes in the segment following the pointer. The pointer value is generated
* from the current layer 2 offset.
*
* If the current offset is beyond the end of packet data, the returned values
* are undefined. The returned pointer can have any value, including NULL, and
* the value written to 'len' can be any value.
*
* @param pkt Packet handle
* @param[out] len Number of data bytes remaining in the segment (output).
* Ignored when NULL.
Expand Down Expand Up @@ -1592,8 +1596,11 @@ uint32_t odp_packet_l2_offset(odp_packet_t pkt);
* Set layer 2 start offset
*
* Set offset to the start of layer 2. The offset is calculated from the current
* odp_packet_data() position in bytes. Offset must not exceed packet data
* length. Offset is not modified on an error.
* odp_packet_data() position in bytes. The offset must not exceed the current
* packet data length but later packet truncation or pulling operations do not
* modify the offset and may result in the offset exceeding packet data length.
*
* Offset is not modified on an error.
*
* @param pkt Packet handle
* @param offset Layer 2 start offset (0 ... odp_packet_len()-1)
Expand All @@ -1610,6 +1617,10 @@ int odp_packet_l2_offset_set(odp_packet_t pkt, uint32_t offset);
* bytes in the segment following the pointer. The pointer value is generated
* from the current layer 3 offset.
*
* If the current offset is beyond the end of packet data, the returned values
* are undefined. The returned pointer can have any value, including NULL, and
* the value written to 'len' can be any value.
*
* @param pkt Packet handle
* @param[out] len Number of data bytes remaining in the segment (output).
* Ignored when NULL.
Expand Down Expand Up @@ -1643,8 +1654,11 @@ uint32_t odp_packet_l3_offset(odp_packet_t pkt);
* Set layer 3 start offset
*
* Set offset to the start of layer 3. The offset is calculated from the current
* odp_packet_data() position in bytes. Offset must not exceed packet data
* length. Offset is not modified on an error.
* odp_packet_data() position in bytes. The offset must not exceed the current
* packet data length but later packet truncation or pulling operations do not
* modify the offset and may result in the offset exceeding packet data length.
*
* Offset is not modified on an error.
*
* @param pkt Packet handle
* @param offset Layer 3 start offset (0 ... odp_packet_len()-1)
Expand All @@ -1661,6 +1675,10 @@ int odp_packet_l3_offset_set(odp_packet_t pkt, uint32_t offset);
* bytes in the segment following the pointer. The pointer value is generated
* from the current layer 4 offset.
*
* If the current offset is beyond the end of packet data, the returned values
* are undefined. The returned pointer can have any value, including NULL, and
* the value written to 'len' can be any value.
*
* @param pkt Packet handle
* @param[out] len Number of data bytes remaining in the segment (output).
* Ignored when NULL.
Expand Down Expand Up @@ -1694,8 +1712,11 @@ uint32_t odp_packet_l4_offset(odp_packet_t pkt);
* Set layer 4 start offset
*
* Set offset to the start of layer 4. The offset is calculated from the current
* odp_packet_data() position in bytes. Offset must not exceed packet data
* length. Offset is not modified on an error.
* odp_packet_data() position in bytes. The offset must not exceed the current
* packet data length but later packet truncation or pulling operations do not
* modify the offset and may result in the offset exceeding packet data length.
*
* Offset is not modified on an error.
*
* @param pkt Packet handle
* @param offset Layer 4 start offset (0 ... odp_packet_len()-1)
Expand Down