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_wait(struct udpif *);
41 void udpif_revalidate(struct udpif *);
43 /* udpif figures out how to forward packets, and does forward them, but it
44 * can't set up datapath flows on its own. This interface passes packet
45 * forwarding data from udpif to the higher level ofproto_dpif to allow the
46 * latter to set up datapath flows. */
48 /* Flow miss batching.
50 * Some dpifs implement operations faster when you hand them off in a batch.
51 * To allow batching, "struct flow_miss" queues the dpif-related work needed
52 * for a given flow. Each "struct flow_miss" corresponds to sending one or
53 * more packets, plus possibly installing the flow in the dpif. */
55 struct hmap_node hmap_node;
56 struct ofproto_dpif *ofproto;
59 enum odp_key_fitness key_fitness;
60 const struct nlattr *key;
62 enum dpif_upcall_type upcall_type;
63 struct dpif_flow_stats stats;
65 struct xlate_out xout;
68 struct flow_miss_batch {
69 struct list list_node;
71 struct flow_miss miss_buf[FLOW_MISS_MAX_BATCH];
74 unsigned int reval_seq;
76 /* Flow misses refer to the memory held by "struct upcall"s,
77 * so we need to keep track of the upcalls to be able to
78 * free them when done. */
79 struct list upcalls; /* Contains "struct upcall"s. */
82 struct flow_miss_batch *flow_miss_batch_next(struct udpif *);
83 void flow_miss_batch_destroy(struct flow_miss_batch *);
85 /* Drop keys are odp flow keys which have drop flows installed in the kernel.
86 * These are datapath flows which have no associated ofproto, if they did we
89 * udpif can't install drop flows by itself. This interfaces allows udpif to
90 * pass the drop flows up to ofproto_dpif to get it to install them. */
92 struct hmap_node hmap_node;
93 struct list list_node;
98 struct drop_key *drop_key_next(struct udpif *);
99 void drop_key_destroy(struct drop_key *);
100 void udpif_drop_key_clear(struct udpif *);
102 #endif /* ofproto-dpif-upcall.h */