ofproto/ofproto-dpif-upcall.h

   1 /* Copyright (c) 2013 Nicira, Inc.
   2  *
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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. */
  14
  15 #ifndef OFPROTO_DPIF_UPCALL_H
  16 #define OFPROTO_DPIF_UPCALL_H
  17
  18 #define FLOW_MISS_MAX_BATCH 50
  19
  20 #include "dpif.h"
  21 #include "flow.h"
  22 #include "hmap.h"
  23 #include "list.h"
  24 #include "odp-util.h"
  25 #include "ofpbuf.h"
  26 #include "ofproto-dpif-xlate.h"
  27
  28 struct dpif;
  29 struct dpif_backer;
  30
  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
  33  * module. */
  34
  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 *);
  38
  39 void udpif_wait(struct udpif *);
  40
  41 void udpif_revalidate(struct udpif *);
  42 \f
  43 /* udpif can handle some upcalls on its own.  Others need the main ofproto_dpif
  44  * code to handle them.  This interface passes upcalls not handled by udpif up
  45  * to the ofproto_dpif main thread. */
  46
  47 /* Type of an upcall. */
  48 enum upcall_type {
  49     /* Handled internally by udpif code.  Not returned by upcall_next().*/
  50     BAD_UPCALL,                 /* Some kind of bug somewhere. */
  51     MISS_UPCALL,                /* A flow miss.  */
  52
  53     /* Require main thread's involvement.  May be returned by upcall_next(). */
  54     SFLOW_UPCALL,               /* sFlow sample. */
  55     FLOW_SAMPLE_UPCALL,         /* Per-flow sampling. */
  56     IPFIX_UPCALL                /* Per-bridge sampling. */
  57 };
  58
  59 /* An upcall. */
  60 struct upcall {
  61     struct list list_node;          /* For queuing upcalls. */
  62
  63     enum upcall_type type;          /* Classification. */
  64
  65     /* Raw upcall plus data for keeping track of the memory backing it. */
  66     struct dpif_upcall dpif_upcall; /* As returned by dpif_recv() */
  67     struct ofpbuf upcall_buf;       /* Owns some data in 'dpif_upcall'. */
  68     uint64_t upcall_stub[512 / 8];  /* Buffer to reduce need for malloc(). */
  69 };
  70
  71 struct upcall *upcall_next(struct udpif *);
  72 void upcall_destroy(struct upcall *);
  73 \f
  74 /* udpif figures out how to forward packets, and does forward them, but it
  75  * can't set up datapath flows on its own.  This interface passes packet
  76  * forwarding data from udpif to the higher level ofproto_dpif to allow the
  77  * latter to set up datapath flows. */
  78
  79 /* Flow miss batching.
  80  *
  81  * Some dpifs implement operations faster when you hand them off in a batch.
  82  * To allow batching, "struct flow_miss" queues the dpif-related work needed
  83  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
  84  * more packets, plus possibly installing the flow in the dpif. */
  85 struct flow_miss {
  86     struct hmap_node hmap_node;
  87     struct ofproto_dpif *ofproto;
  88
  89     struct flow flow;
  90     enum odp_key_fitness key_fitness;
  91     const struct nlattr *key;
  92     size_t key_len;
  93     struct list packets;
  94     enum dpif_upcall_type upcall_type;
  95     struct dpif_flow_stats stats;
  96
  97     struct xlate_out xout;
  98
  99     struct list upcalls;
 100 };
 101
 102 struct flow_miss_batch {
 103     struct list list_node;
 104
 105     struct flow_miss miss_buf[FLOW_MISS_MAX_BATCH];
 106     struct hmap misses;
 107
 108     unsigned int reval_seq;
 109 };
 110
 111 struct flow_miss_batch *flow_miss_batch_next(struct udpif *);
 112 void flow_miss_batch_destroy(struct flow_miss_batch *);
 113 \f
 114 /* Drop keys are odp flow keys which have drop flows installed in the kernel.
 115  * These are datapath flows which have no associated ofproto, if they did we
 116  * would use facets.
 117  *
 118  * udpif can't install drop flows by itself.  This interfaces allows udpif to
 119  * pass the drop flows up to ofproto_dpif to get it to install them. */
 120 struct drop_key {
 121     struct hmap_node hmap_node;
 122     struct list list_node;
 123     struct nlattr *key;
 124     size_t key_len;
 125 };
 126
 127 struct drop_key *drop_key_next(struct udpif *);
 128 void drop_key_destroy(struct drop_key *);
 129 void udpif_drop_key_clear(struct udpif *);
 130
 131 #endif /* ofproto-dpif-upcall.h */