ofproto: Support OF version-specific table-miss behaviours
[sliver-openvswitch.git] / ofproto / ofproto-dpif.h
index 93e6ec0..ae6f9b7 100644 (file)
@@ -42,6 +42,13 @@ enum rule_dpif_lookup_verdict {
                                              * the controller. */
     RULE_DPIF_LOOKUP_VERDICT_DROP,          /* A miss occurred and the packet
                                              * should be dropped. */
+    RULE_DPIF_LOOKUP_VERDICT_DEFAULT,       /* A miss occurred and the packet
+                                             * should handled by the default
+                                             * miss behaviour.
+                                             * For pre-OF1.3 it should be
+                                             * forwarded to the controller.
+                                             * For OF1.3+ it should be
+                                             * dropped. */
 };
 
 /* For lock annotation below only. */
@@ -130,6 +137,7 @@ int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
     OVS_EXCLUDED(xlate_rwlock);
 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
                                  struct ofproto_packet_in *);
+bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
 
@@ -139,32 +147,35 @@ struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
  * Recirculation
  * =============
  *
- * Recirculation is a technique to allow a frame to re-enter the packet processing
- * path for one or multiple times to achieve more flexible packet processing in the
- * data path. MPLS handling and selecting bond slave port of a bond ports.
+ * Recirculation is a technique to allow a frame to re-enter the packet
+ * processing path for one or multiple times to achieve more flexible packet
+ * processing in the data path. MPLS handling and selecting bond slave port
+ * of a bond ports.
  *
  * Data path and user space interface
  * -----------------------------------
  *
- * Two new fields, recirc_id and dp_hash, are added to the current flow data structure.
- * They are both both of type uint32_t. In addition, a new action, RECIRC, are added.
+ * Two new fields, recirc_id and dp_hash, are added to the current flow data
+ * structure. They are both of type uint32_t. In addition, a new action,
+ * RECIRC, are added.
  *
- * The value recirc_id is used to distinguish a packet from multiple iterations of
- * recirculation. A packet initially received is considered of having recirc_id of 0.
- * Recirc_id is managed by the user space, opaque to the data path.
+ * The value recirc_id is used to distinguish a packet from multiple
+ * iterations of recirculation. A packet initially received is considered of
+ * having recirc_id of 0. Recirc_id is managed by the user space, opaque to
+ * the data path.
  *
  * On the other hand, dp_hash can only be computed by the data path, opaque to
- * the user space. In fact, user space may not able to recompute the hash value.
- * The dp_hash value should be wildcarded when for a newly received packet.
- * RECIRC action specifies whether the hash is computed. If computed, how many
- * fields to be included in the hash computation. The computed hash value is
- * stored into the dp_hash field prior to recirculation.
- *
- * The RECIRC action computes and set the dp_hash field, set the recirc_id field
- * and then reprocess the packet as if it was received on the same input port.
- * RECIRC action works like a function call; actions listed behind the RECIRC
- * action will be executed after its execution.  RECIRC action can be nested,
- * data path implementation limits the number of recirculation executed
+ * the user space. In fact, user space may not able to recompute the hash
+ * value. The dp_hash value should be wildcarded when for a newly received
+ * packet. RECIRC action specifies whether the hash is computed. If computed,
+ * how many fields to be included in the hash computation. The computed hash
+ * value is stored into the dp_hash field prior to recirculation.
+ *
+ * The RECIRC action computes and set the dp_hash field, set the recirc_id
+ * field and then reprocess the packet as if it was received on the same input
+ * port. RECIRC action works like a function call; actions listed behind the
+ * RECIRC action will be executed after its execution.  RECIRC action can be
+ * nested, data path implementation limits the number of recirculation executed
  * to prevent unreasonable nesting depth or infinite loop.
  *
  * Both flow fields and the RECIRC action are exposed as open flow fields via
@@ -174,11 +185,12 @@ struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
  * ------------------------
  *
  * At the open flow level, post recirculation rules are always hidden from the
- * controller.  They are installed in table 254 which is set up as a hidden table
- * during boot time. Those rules are managed by the local user space program only.
+ * controller.  They are installed in table 254 which is set up as a hidden
+ * table during boot time. Those rules are managed by the local user space
+ * program only.
  *
- * To speed up the classifier look up process, recirc_id is always reflected into
- * the metadata field, since recirc_id is required to be exactly matched.
+ * To speed up the classifier look up process, recirc_id is always reflected
+ * into the metadata field, since recirc_id is required to be exactly matched.
  *
  * Classifier look up always starts with table 254. A post recirculation flow
  * lookup should find its hidden rule within this table. On the other hand, A