1 /* Copyright (c) 2013 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License. */
15 #ifndef OFPROTO_DPIF_UPCALL_H
16 #define OFPROTO_DPIF_UPCALL_H
18 #define FLOW_MISS_MAX_BATCH 50
26 #include "ofproto-dpif-xlate.h"
31 /* udif is responsible for retrieving upcalls from the kernel, processing miss
32 * upcalls, and handing more complex ones up to the main ofproto-dpif
35 struct udpif *udpif_create(struct dpif_backer *, struct dpif *);
36 void udpif_recv_set(struct udpif *, size_t n_workers, bool enable);
37 void udpif_destroy(struct udpif *);
39 void udpif_run(struct udpif *);
40 void udpif_wait(struct udpif *);
42 void udpif_revalidate(struct udpif *);
44 /* udpif can handle some upcalls on its own. Others need the main ofproto_dpif
45 * code to handle them. This interface passes upcalls not handled by udpif up
46 * to the ofproto_dpif main thread. */
48 /* Type of an upcall. */
50 /* Handled internally by udpif code. Not returned by upcall_next().*/
51 BAD_UPCALL, /* Some kind of bug somewhere. */
52 MISS_UPCALL, /* A flow miss. */
54 /* Require main thread's involvement. May be returned by upcall_next(). */
55 SFLOW_UPCALL, /* sFlow sample. */
56 FLOW_SAMPLE_UPCALL, /* Per-flow sampling. */
57 IPFIX_UPCALL /* Per-bridge sampling. */
62 struct list list_node; /* For queuing upcalls. */
64 enum upcall_type type; /* Classification. */
66 /* Raw upcall plus data for keeping track of the memory backing it. */
67 struct dpif_upcall dpif_upcall; /* As returned by dpif_recv() */
68 struct ofpbuf upcall_buf; /* Owns some data in 'dpif_upcall'. */
69 uint64_t upcall_stub[512 / 8]; /* Buffer to reduce need for malloc(). */
72 struct upcall *upcall_next(struct udpif *);
73 void upcall_destroy(struct upcall *);
75 /* udpif figures out how to forward packets, and does forward them, but it
76 * can't set up datapath flows on its own. This interface passes packet
77 * forwarding data from udpif to the higher level ofproto_dpif to allow the
78 * latter to set up datapath flows. */
80 /* Flow miss batching.
82 * Some dpifs implement operations faster when you hand them off in a batch.
83 * To allow batching, "struct flow_miss" queues the dpif-related work needed
84 * for a given flow. Each "struct flow_miss" corresponds to sending one or
85 * more packets, plus possibly installing the flow in the dpif. */
87 struct hmap_node hmap_node;
88 struct ofproto_dpif *ofproto;
91 enum odp_key_fitness key_fitness;
92 const struct nlattr *key;
95 enum dpif_upcall_type upcall_type;
96 struct dpif_flow_stats stats;
98 struct xlate_out xout;
103 struct flow_miss_batch {
104 struct list list_node;
106 struct flow_miss miss_buf[FLOW_MISS_MAX_BATCH];
110 struct flow_miss_batch *flow_miss_batch_next(struct udpif *);
111 void flow_miss_batch_destroy(struct flow_miss_batch *);
113 void flow_miss_batch_ofproto_destroyed(struct udpif *,
114 const struct ofproto_dpif *);
116 /* Drop keys are odp flow keys which have drop flows installed in the kernel.
117 * These are datapath flows which have no associated ofproto, if they did we
120 * udpif can't install drop flows by itself. This interfaces allows udpif to
121 * pass the drop flows up to ofproto_dpif to get it to install them. */
123 struct hmap_node hmap_node;
124 struct list list_node;
129 struct drop_key *drop_key_next(struct udpif *);
130 void drop_key_destroy(struct drop_key *);
131 void udpif_drop_key_clear(struct udpif *);
133 #endif /* ofproto-dpif-upcall.h */