mir/openvswitch
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-10-25 15:07:05 +00:00
Code Issues Releases Wiki Activity

ofp-util: Improve comments on struct ofputil_packet_in.

Browse Source 
Signed-off-by: Ben Pfaff <blp@nicira.com>
This commit is contained in:
Ben Pfaff
2013-10-22 16:38:46 -07:00
parent d38a3c7b8e
commit 22ee354476
1 changed files with 23 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
lib/ofp-util.h
View File

@@ -376,17 +376,33 @@ struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
/* Abstract packet-in message. */
struct ofputil_packet_in {
/* Packet data and metadata.
*
* To save bandwidth, in some cases a switch may send only the first
* several bytes of a packet, indicated by 'packet_len < total_len'. When
* the full packet is included, 'packet_len == total_len'. */
const void *packet;
size_t packet_len;
enum ofp_packet_in_reason reason; /* One of OFPR_*. */
uint8_t table_id;
ovs_be64 cookie;
size_t packet_len; /* Number of bytes in 'packet'. */
size_t total_len; /* Size of packet, pre-truncation. */
struct flow_metadata fmd;
/* Identifies a buffer in the switch that contains the full packet, to
* allow the controller to reference it later without having to send the
* entire packet back to the switch.
*
* UINT32_MAX indicates that the packet is not buffered in the switch. A
* switch should only use UINT32_MAX when it sends the entire packet. */
uint32_t buffer_id;
uint16_t total_len; /* Full length of frame. */
struct flow_metadata fmd; /* Metadata at creation time. */
/* Reason that the packet-in is being sent. */
enum ofp_packet_in_reason reason; /* One of OFPR_*. */
/* Information about the OpenFlow flow that triggered the packet-in.
*
* A packet-in triggered by a flow table miss has no associated flow. In
* that case, 'cookie' is 0. */
uint8_t table_id; /* OpenFlow table ID. */
ovs_be64 cookie; /* Flow's cookie. */
};
enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,