2 * Copyright (c) 2008, 2009 Nicira Networks.
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include <sys/types.h>
20 #include <netinet/in.h>
24 #include "dynamic-string.h"
27 #include "openflow/openflow.h"
28 #include "openvswitch/datapath-protocol.h"
32 #define THIS_MODULE VLM_flow
34 static struct ip_header *
35 pull_ip(struct ofpbuf *packet)
37 if (packet->size >= IP_HEADER_LEN) {
38 struct ip_header *ip = packet->data;
39 int ip_len = IP_IHL(ip->ip_ihl_ver) * 4;
40 if (ip_len >= IP_HEADER_LEN && packet->size >= ip_len) {
41 return ofpbuf_pull(packet, ip_len);
47 static struct tcp_header *
48 pull_tcp(struct ofpbuf *packet)
50 if (packet->size >= TCP_HEADER_LEN) {
51 struct tcp_header *tcp = packet->data;
52 int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
53 if (tcp_len >= TCP_HEADER_LEN && packet->size >= tcp_len) {
54 return ofpbuf_pull(packet, tcp_len);
60 static struct udp_header *
61 pull_udp(struct ofpbuf *packet)
63 return ofpbuf_try_pull(packet, UDP_HEADER_LEN);
66 static struct icmp_header *
67 pull_icmp(struct ofpbuf *packet)
69 return ofpbuf_try_pull(packet, ICMP_HEADER_LEN);
72 static struct eth_header *
73 pull_eth(struct ofpbuf *packet)
75 return ofpbuf_try_pull(packet, ETH_HEADER_LEN);
78 static struct vlan_header *
79 pull_vlan(struct ofpbuf *packet)
81 return ofpbuf_try_pull(packet, VLAN_HEADER_LEN);
84 /* Returns 1 if 'packet' is an IP fragment, 0 otherwise. */
86 flow_extract(struct ofpbuf *packet, uint16_t in_port, flow_t *flow)
88 struct ofpbuf b = *packet;
89 struct eth_header *eth;
92 COVERAGE_INC(flow_extract);
94 memset(flow, 0, sizeof *flow);
95 flow->dl_vlan = htons(OFP_VLAN_NONE);
96 flow->in_port = in_port;
105 if (ntohs(eth->eth_type) >= OFP_DL_TYPE_ETH2_CUTOFF) {
106 /* This is an Ethernet II frame */
107 flow->dl_type = eth->eth_type;
109 /* This is an 802.2 frame */
110 struct llc_header *llc = ofpbuf_at(&b, 0, sizeof *llc);
111 struct snap_header *snap = ofpbuf_at(&b, sizeof *llc,
117 && llc->llc_dsap == LLC_DSAP_SNAP
118 && llc->llc_ssap == LLC_SSAP_SNAP
119 && llc->llc_cntl == LLC_CNTL_SNAP
120 && !memcmp(snap->snap_org, SNAP_ORG_ETHERNET,
121 sizeof snap->snap_org)) {
122 flow->dl_type = snap->snap_type;
123 ofpbuf_pull(&b, LLC_SNAP_HEADER_LEN);
125 flow->dl_type = htons(OFP_DL_TYPE_NOT_ETH_TYPE);
126 ofpbuf_pull(&b, sizeof(struct llc_header));
130 /* Check for a VLAN tag */
131 if (flow->dl_type == htons(ETH_TYPE_VLAN)) {
132 struct vlan_header *vh = pull_vlan(&b);
134 flow->dl_type = vh->vlan_next_type;
135 flow->dl_vlan = vh->vlan_tci & htons(VLAN_VID_MASK);
138 memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
139 memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
142 if (flow->dl_type == htons(ETH_TYPE_IP)) {
143 const struct ip_header *nh = pull_ip(&b);
145 flow->nw_src = nh->ip_src;
146 flow->nw_dst = nh->ip_dst;
147 flow->nw_proto = nh->ip_proto;
149 if (!IP_IS_FRAGMENT(nh->ip_frag_off)) {
150 if (flow->nw_proto == IP_TYPE_TCP) {
151 const struct tcp_header *tcp = pull_tcp(&b);
153 flow->tp_src = tcp->tcp_src;
154 flow->tp_dst = tcp->tcp_dst;
157 /* Avoid tricking other code into thinking that
158 * this packet has an L4 header. */
161 } else if (flow->nw_proto == IP_TYPE_UDP) {
162 const struct udp_header *udp = pull_udp(&b);
164 flow->tp_src = udp->udp_src;
165 flow->tp_dst = udp->udp_dst;
168 /* Avoid tricking other code into thinking that
169 * this packet has an L4 header. */
172 } else if (flow->nw_proto == IP_TYPE_ICMP) {
173 const struct icmp_header *icmp = pull_icmp(&b);
175 flow->icmp_type = htons(icmp->icmp_type);
176 flow->icmp_code = htons(icmp->icmp_code);
179 /* Avoid tricking other code into thinking that
180 * this packet has an L4 header. */
193 /* Extracts the flow stats for a packet. The 'flow' and 'packet'
194 * arguments must have been initialized through a call to flow_extract().
197 flow_extract_stats(const flow_t *flow, struct ofpbuf *packet,
198 struct odp_flow_stats *stats)
200 memset(stats, '\0', sizeof(*stats));
202 if ((flow->dl_type == htons(ETH_TYPE_IP)) && packet->l4) {
203 struct ip_header *ip = packet->l3;
204 stats->ip_tos = ip->ip_tos;
205 if ((flow->nw_proto == IP_TYPE_TCP) && packet->l7) {
206 struct tcp_header *tcp = packet->l4;
207 stats->tcp_flags = TCP_FLAGS(tcp->tcp_ctl);
211 stats->n_bytes = packet->size;
212 stats->n_packets = 1;
216 flow_to_match(const flow_t *flow, uint32_t wildcards, struct ofp_match *match)
218 match->wildcards = htonl(wildcards);
219 match->in_port = htons(flow->in_port == ODPP_LOCAL ? OFPP_LOCAL
221 match->dl_vlan = flow->dl_vlan;
222 memcpy(match->dl_src, flow->dl_src, ETH_ADDR_LEN);
223 memcpy(match->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
224 match->dl_type = flow->dl_type;
225 match->nw_src = flow->nw_src;
226 match->nw_dst = flow->nw_dst;
227 match->nw_proto = flow->nw_proto;
228 match->tp_src = flow->tp_src;
229 match->tp_dst = flow->tp_dst;
234 flow_from_match(flow_t *flow, uint32_t *wildcards,
235 const struct ofp_match *match)
238 *wildcards = ntohl(match->wildcards);
240 flow->nw_src = match->nw_src;
241 flow->nw_dst = match->nw_dst;
242 flow->in_port = (match->in_port == htons(OFPP_LOCAL) ? ODPP_LOCAL
243 : ntohs(match->in_port));
244 flow->dl_vlan = match->dl_vlan;
245 flow->dl_type = match->dl_type;
246 flow->tp_src = match->tp_src;
247 flow->tp_dst = match->tp_dst;
248 memcpy(flow->dl_src, match->dl_src, ETH_ADDR_LEN);
249 memcpy(flow->dl_dst, match->dl_dst, ETH_ADDR_LEN);
250 flow->nw_proto = match->nw_proto;
255 flow_to_string(const flow_t *flow)
257 struct ds ds = DS_EMPTY_INITIALIZER;
258 flow_format(&ds, flow);
263 flow_format(struct ds *ds, const flow_t *flow)
265 ds_put_format(ds, "port%04x:vlan%d mac"ETH_ADDR_FMT"->"ETH_ADDR_FMT" "
266 "type%04x proto%"PRId8" ip"IP_FMT"->"IP_FMT" port%d->%d",
267 flow->in_port, ntohs(flow->dl_vlan),
268 ETH_ADDR_ARGS(flow->dl_src), ETH_ADDR_ARGS(flow->dl_dst),
269 ntohs(flow->dl_type), flow->nw_proto,
270 IP_ARGS(&flow->nw_src), IP_ARGS(&flow->nw_dst),
271 ntohs(flow->tp_src), ntohs(flow->tp_dst));
275 flow_print(FILE *stream, const flow_t *flow)
277 char *s = flow_to_string(flow);