ofproto/ofproto-provider.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OFPROTO_OFPROTO_PROVIDER_H
  18 #define OFPROTO_OFPROTO_PROVIDER_H 1
  19
  20 /* Definitions for use within ofproto. */
  21
  22 #include "cfm.h"
  23 #include "classifier.h"
  24 #include "heap.h"
  25 #include "hindex.h"
  26 #include "list.h"
  27 #include "ofp-errors.h"
  28 #include "ofp-util.h"
  29 #include "ofproto/ofproto.h"
  30 #include "ovs-thread.h"
  31 #include "shash.h"
  32 #include "simap.h"
  33 #include "timeval.h"
  34
  35 struct match;
  36 struct ofpact;
  37 struct ofputil_flow_mod;
  38 struct bfd_cfg;
  39 struct meter;
  40
  41 /* An OpenFlow switch.
  42  *
  43  * With few exceptions, ofproto implementations may look at these fields but
  44  * should not modify them. */
  45 struct ofproto {
  46     struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
  47     const struct ofproto_class *ofproto_class;
  48     char *type;                 /* Datapath type. */
  49     char *name;                 /* Datapath name. */
  50
  51     /* Settings. */
  52     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
  53     uint64_t datapath_id;       /* Datapath ID. */
  54     bool forward_bpdu;          /* Option to allow forwarding of BPDU frames
  55                                  * when NORMAL action is invoked. */
  56     char *mfr_desc;             /* Manufacturer (NULL for default)b. */
  57     char *hw_desc;              /* Hardware (NULL for default). */
  58     char *sw_desc;              /* Software version (NULL for default). */
  59     char *serial_desc;          /* Serial number (NULL for default). */
  60     char *dp_desc;              /* Datapath description (NULL for default). */
  61     enum ofp_config_flags frag_handling; /* One of OFPC_*.  */
  62
  63     /* Datapath. */
  64     struct hmap ports;          /* Contains "struct ofport"s. */
  65     struct shash port_by_name;
  66     unsigned long *ofp_port_ids;/* Bitmap of used OpenFlow port numbers. */
  67     struct simap ofp_requests;  /* OpenFlow port number requests. */
  68     uint16_t alloc_port_no;     /* Last allocated OpenFlow port number. */
  69     uint16_t max_ports;         /* Max possible OpenFlow port num, plus one. */
  70
  71     /* Flow tables. */
  72     struct oftable *tables;
  73     int n_tables;
  74
  75     struct hindex cookies;      /* Rules indexed on their cookie values. */
  76
  77     /* Optimisation for flow expiry.
  78      * These flows should all be present in tables. */
  79     struct ovs_mutex expirable_mutex;
  80     struct list expirable OVS_GUARDED; /* Expirable 'struct rule"s in all
  81                                           tables. */
  82
  83     /* Meter table.
  84      * OpenFlow meters start at 1.  To avoid confusion we leave the first
  85      * pointer in the array un-used, and index directly with the OpenFlow
  86      * meter_id. */
  87     struct ofputil_meter_features meter_features;
  88     struct meter **meters; /* 'meter_features.max_meter' + 1 pointers. */
  89
  90     /* OpenFlow connections. */
  91     struct connmgr *connmgr;
  92
  93     /* Flow table operation tracking. */
  94     int state;                  /* Internal state. */
  95     struct list pending;        /* List of "struct ofopgroup"s. */
  96     unsigned int n_pending;     /* list_size(&pending). */
  97     struct hmap deletions;      /* All OFOPERATION_DELETE "ofoperation"s. */
  98
  99     /* Flow table operation logging. */
 100     int n_add, n_delete, n_modify; /* Number of unreported ops of each kind. */
 101     long long int first_op, last_op; /* Range of times for unreported ops. */
 102     long long int next_op_report;    /* Time to report ops, or LLONG_MAX. */
 103     long long int op_backoff;        /* Earliest time to report ops again. */
 104
 105     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 106      *
 107      * This is deprecated.  It is only for compatibility with broken device
 108      * drivers in old versions of Linux that do not properly support VLANs when
 109      * VLAN devices are not used.  When broken device drivers are no longer in
 110      * widespread use, we will delete these interfaces. */
 111     unsigned long int *vlan_bitmap; /* 4096-bit bitmap of in-use VLANs. */
 112     bool vlans_changed;             /* True if new VLANs are in use. */
 113     int min_mtu;                    /* Current MTU of non-internal ports. */
 114 };
 115
 116 void ofproto_init_tables(struct ofproto *, int n_tables);
 117 void ofproto_init_max_ports(struct ofproto *, uint16_t max_ports);
 118
 119 struct ofproto *ofproto_lookup(const char *name);
 120 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
 121
 122 /* An OpenFlow port within a "struct ofproto".
 123  *
 124  * With few exceptions, ofproto implementations may look at these fields but
 125  * should not modify them. */
 126 struct ofport {
 127     struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
 128     struct ofproto *ofproto;    /* The ofproto that contains this port. */
 129     struct netdev *netdev;
 130     struct ofputil_phy_port pp;
 131     ofp_port_t ofp_port;        /* OpenFlow port number. */
 132     unsigned int change_seq;
 133     long long int created;      /* Time created, in msec. */
 134     int mtu;
 135 };
 136
 137 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
 138
 139 /* OpenFlow table flags:
 140  *
 141  *   - "Hidden" tables are not included in OpenFlow operations that operate on
 142  *     "all tables".  For example, a request for flow stats on all tables will
 143  *     omit flows in hidden tables, table stats requests will omit the table
 144  *     entirely, and the switch features reply will not count the hidden table.
 145  *
 146  *     However, operations that specifically name the particular table still
 147  *     operate on it.  For example, flow_mods and flow stats requests on a
 148  *     hidden table work.
 149  *
 150  *     To avoid gaps in table IDs (which have unclear validity in OpenFlow),
 151  *     hidden tables must be the highest-numbered tables that a provider
 152  *     implements.
 153  *
 154  *   - "Read-only" tables can't be changed through OpenFlow operations.  (At
 155  *     the moment all flow table operations go effectively through OpenFlow, so
 156  *     this means that read-only tables can't be changed at all after the
 157  *     read-only flag is set.)
 158  *
 159  * The generic ofproto layer never sets these flags.  An ofproto provider can
 160  * set them if it is appropriate.
 161  */
 162 enum oftable_flags {
 163     OFTABLE_HIDDEN = 1 << 0,   /* Hide from most OpenFlow operations. */
 164     OFTABLE_READONLY = 1 << 1  /* Don't allow OpenFlow to change this table. */
 165 };
 166
 167 /* A flow table within a "struct ofproto". */
 168 struct oftable {
 169     enum oftable_flags flags;
 170     struct classifier cls;      /* Contains "struct rule"s. */
 171     char *name;                 /* Table name exposed via OpenFlow, or NULL. */
 172
 173     /* Maximum number of flows or UINT_MAX if there is no limit besides any
 174      * limit imposed by resource limitations. */
 175     unsigned int max_flows;
 176
 177     /* These members determine the handling of an attempt to add a flow that
 178      * would cause the table to have more than 'max_flows' flows.
 179      *
 180      * If 'eviction_fields' is NULL, overflows will be rejected with an error.
 181      *
 182      * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
 183      * is nonzero), an overflow will cause a flow to be removed.  The flow to
 184      * be removed is chosen to give fairness among groups distinguished by
 185      * different values for the subfields within 'groups'. */
 186     struct mf_subfield *eviction_fields;
 187     size_t n_eviction_fields;
 188
 189     /* Eviction groups.
 190      *
 191      * When a flow is added that would cause the table to have more than
 192      * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
 193      * used to decide which rule to evict: the rule is chosen from the eviction
 194      * group that contains the greatest number of rules.*/
 195     uint32_t eviction_group_id_basis;
 196     struct hmap eviction_groups_by_id;
 197     struct heap eviction_groups_by_size;
 198 };
 199
 200 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
 201  *
 202  * All parameters are evaluated multiple times. */
 203 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO)              \
 204     for ((TABLE) = (OFPROTO)->tables;                       \
 205          (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
 206          (TABLE)++)
 207
 208 /* An OpenFlow flow within a "struct ofproto".
 209  *
 210  * With few exceptions, ofproto implementations may look at these fields but
 211  * should not modify them. */
 212 struct rule {
 213     struct list ofproto_node;    /* Owned by ofproto base code. */
 214     struct ofproto *ofproto;     /* The ofproto that contains this rule. */
 215     struct cls_rule cr;          /* In owning ofproto's classifier. */
 216
 217     struct ofoperation *pending; /* Operation now in progress, if nonnull. */
 218
 219     ovs_be64 flow_cookie;        /* Controller-issued identifier. */
 220     struct hindex_node cookie_node; /* In owning ofproto's 'cookies' index. */
 221
 222     long long int created;       /* Creation time. */
 223     long long int modified;      /* Time of last modification. */
 224     long long int used;          /* Last use; time created if never used. */
 225     uint8_t table_id;            /* Index in ofproto's 'tables' array. */
 226     bool send_flow_removed;      /* Send a flow removed message? */
 227
 228     struct ovs_mutex timeout_mutex;
 229     uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
 230     uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
 231
 232     /* Eviction groups. */
 233     struct heap_node evg_node;   /* In eviction_group's "rules" heap. */
 234     struct eviction_group *eviction_group; /* NULL if not in any group. */
 235
 236     /* The evict lock is used to prevent rules from being evicted while child
 237      * threads are using them to xlate flows.  A read lock means the rule is
 238      * currently being used.  A write lock means the rule is in the process of
 239      * being evicted and should be considered gone.  A rule will not be evicted
 240      * unless both its own and its classifiers write locks are held.
 241      * Therefore, while holding a classifier readlock, one can be assured that
 242      * even write locked rules are safe. */
 243     struct ovs_rwlock evict;
 244
 245     struct ofpact *ofpacts;      /* Sequence of "struct ofpacts". */
 246     unsigned int ofpacts_len;    /* Size of 'ofpacts', in bytes. */
 247
 248     uint32_t meter_id;           /* Non-zero OF meter_id, or zero. */
 249     struct list meter_list_node; /* In owning meter's 'rules' list. */
 250
 251     /* Flow monitors. */
 252     enum nx_flow_monitor_flags monitor_flags;
 253     uint64_t add_seqno;         /* Sequence number when added. */
 254     uint64_t modify_seqno;      /* Sequence number when changed. */
 255
 256     /* Optimisation for flow expiry. */
 257     struct list expirable;      /* In ofproto's 'expirable' list if this rule
 258                                  * is expirable, otherwise empty. */
 259 };
 260
 261 /* Threshold at which to begin flow table eviction. Only affects the
 262  * ofproto-dpif implementation */
 263 extern unsigned flow_eviction_threshold;
 264
 265 /* Number of upcall handler threads. Only affects the ofproto-dpif
 266  * implementation. */
 267 extern unsigned n_handler_threads;
 268
 269 /* Determines which model to use for handling misses in the ofproto-dpif
 270  * implementation */
 271 extern enum ofproto_flow_miss_model flow_miss_model;
 272
 273 static inline struct rule *
 274 rule_from_cls_rule(const struct cls_rule *cls_rule)
 275 {
 276     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
 277 }
 278
 279 void ofproto_rule_update_used(struct rule *, long long int used);
 280 void ofproto_rule_expire(struct rule *rule, uint8_t reason);
 281 void ofproto_rule_delete(struct ofproto *, struct classifier *cls,
 282                          struct rule *) OVS_REQ_WRLOCK(cls->rwlock);
 283 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
 284                                   uint16_t hard_timeout)
 285     OVS_EXCLUDED(rule->ofproto->expirable_mutex, rule->timeout_mutex);
 286
 287 bool ofproto_rule_has_out_port(const struct rule *, ofp_port_t out_port);
 288
 289 void ofoperation_complete(struct ofoperation *, enum ofperr);
 290
 291 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port);
 292
 293 bool ofproto_rule_is_hidden(const struct rule *);
 294
 295 /* ofproto class structure, to be defined by each ofproto implementation.
 296  *
 297  *
 298  * Data Structures
 299  * ===============
 300  *
 301  * These functions work primarily with three different kinds of data
 302  * structures:
 303  *
 304  *   - "struct ofproto", which represents an OpenFlow switch.
 305  *
 306  *   - "struct ofport", which represents a port within an ofproto.
 307  *
 308  *   - "struct rule", which represents an OpenFlow flow within an ofproto.
 309  *
 310  * Each of these data structures contains all of the implementation-independent
 311  * generic state for the respective concept, called the "base" state.  None of
 312  * them contains any extra space for ofproto implementations to use.  Instead,
 313  * each implementation is expected to declare its own data structure that
 314  * contains an instance of the generic data structure plus additional
 315  * implementation-specific members, called the "derived" state.  The
 316  * implementation can use casts or (preferably) the CONTAINER_OF macro to
 317  * obtain access to derived state given only a pointer to the embedded generic
 318  * data structure.
 319  *
 320  *
 321  * Life Cycle
 322  * ==========
 323  *
 324  * Four stylized functions accompany each of these data structures:
 325  *
 326  *            "alloc"       "construct"       "destruct"       "dealloc"
 327  *            ------------  ----------------  ---------------  --------------
 328  *   ofproto  ->alloc       ->construct       ->destruct       ->dealloc
 329  *   ofport   ->port_alloc  ->port_construct  ->port_destruct  ->port_dealloc
 330  *   rule     ->rule_alloc  ->rule_construct  ->rule_destruct  ->rule_dealloc
 331  *
 332  * "ofproto" and "ofport" have this exact life cycle.  The "rule" data
 333  * structure also follow this life cycle with some additional elaborations
 334  * described under "Rule Life Cycle" below.
 335  *
 336  * Any instance of a given data structure goes through the following life
 337  * cycle:
 338  *
 339  *   1. The client calls the "alloc" function to obtain raw memory.  If "alloc"
 340  *      fails, skip all the other steps.
 341  *
 342  *   2. The client initializes all of the data structure's base state.  If this
 343  *      fails, skip to step 7.
 344  *
 345  *   3. The client calls the "construct" function.  The implementation
 346  *      initializes derived state.  It may refer to the already-initialized
 347  *      base state.  If "construct" fails, skip to step 6.
 348  *
 349  *   4. The data structure is now initialized and in use.
 350  *
 351  *   5. When the data structure is no longer needed, the client calls the
 352  *      "destruct" function.  The implementation uninitializes derived state.
 353  *      The base state has not been uninitialized yet, so the implementation
 354  *      may still refer to it.
 355  *
 356  *   6. The client uninitializes all of the data structure's base state.
 357  *
 358  *   7. The client calls the "dealloc" to free the raw memory.  The
 359  *      implementation must not refer to base or derived state in the data
 360  *      structure, because it has already been uninitialized.
 361  *
 362  * Each "alloc" function allocates and returns a new instance of the respective
 363  * data structure.  The "alloc" function is not given any information about the
 364  * use of the new data structure, so it cannot perform much initialization.
 365  * Its purpose is just to ensure that the new data structure has enough room
 366  * for base and derived state.  It may return a null pointer if memory is not
 367  * available, in which case none of the other functions is called.
 368  *
 369  * Each "construct" function initializes derived state in its respective data
 370  * structure.  When "construct" is called, all of the base state has already
 371  * been initialized, so the "construct" function may refer to it.  The
 372  * "construct" function is allowed to fail, in which case the client calls the
 373  * "dealloc" function (but not the "destruct" function).
 374  *
 375  * Each "destruct" function uninitializes and frees derived state in its
 376  * respective data structure.  When "destruct" is called, the base state has
 377  * not yet been uninitialized, so the "destruct" function may refer to it.  The
 378  * "destruct" function is not allowed to fail.
 379  *
 380  * Each "dealloc" function frees raw memory that was allocated by the the
 381  * "alloc" function.  The memory's base and derived members might not have ever
 382  * been initialized (but if "construct" returned successfully, then it has been
 383  * "destruct"ed already).  The "dealloc" function is not allowed to fail.
 384  *
 385  *
 386  * Conventions
 387  * ===========
 388  *
 389  * Most of these functions return 0 if they are successful or a positive error
 390  * code on failure.  Depending on the function, valid error codes are either
 391  * errno values or OFPERR_* OpenFlow error codes.
 392  *
 393  * Most of these functions are expected to execute synchronously, that is, to
 394  * block as necessary to obtain a result.  Thus, these functions may return
 395  * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
 396  * explicitly say those errors are a possibility.  We may relax this
 397  * requirement in the future if and when we encounter performance problems. */
 398 struct ofproto_class {
 399 /* ## ----------------- ## */
 400 /* ## Factory Functions ## */
 401 /* ## ----------------- ## */
 402
 403     /* Initializes provider.  The caller may pass in 'iface_hints',
 404      * which contains an shash of "struct iface_hint" elements indexed
 405      * by the interface's name.  The provider may use these hints to
 406      * describe the startup configuration in order to reinitialize its
 407      * state.  The caller owns the provided data, so a provider must
 408      * make copies of anything required.  An ofproto provider must
 409      * remove any existing state that is not described by the hint, and
 410      * may choose to remove it all. */
 411     void (*init)(const struct shash *iface_hints);
 412
 413     /* Enumerates the types of all support ofproto types into 'types'.  The
 414      * caller has already initialized 'types' and other ofproto classes might
 415      * already have added names to it. */
 416     void (*enumerate_types)(struct sset *types);
 417
 418     /* Enumerates the names of all existing datapath of the specified 'type'
 419      * into 'names' 'all_dps'.  The caller has already initialized 'names' as
 420      * an empty sset.
 421      *
 422      * 'type' is one of the types enumerated by ->enumerate_types().
 423      *
 424      * Returns 0 if successful, otherwise a positive errno value.
 425      */
 426     int (*enumerate_names)(const char *type, struct sset *names);
 427
 428     /* Deletes the datapath with the specified 'type' and 'name'.  The caller
 429      * should have closed any open ofproto with this 'type' and 'name'; this
 430      * function is allowed to fail if that is not the case.
 431      *
 432      * 'type' is one of the types enumerated by ->enumerate_types().
 433      * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
 434      *
 435      * Returns 0 if successful, otherwise a positive errno value.
 436      */
 437     int (*del)(const char *type, const char *name);
 438
 439     /* Returns the type to pass to netdev_open() when a datapath of type
 440      * 'datapath_type' has a port of type 'port_type', for a few special
 441      * cases when a netdev type differs from a port type.  For example,
 442      * when using the userspace datapath, a port of type "internal"
 443      * needs to be opened as "tap".
 444      *
 445      * Returns either 'type' itself or a string literal, which must not
 446      * be freed. */
 447     const char *(*port_open_type)(const char *datapath_type,
 448                                   const char *port_type);
 449
 450 /* ## ------------------------ ## */
 451 /* ## Top-Level type Functions ## */
 452 /* ## ------------------------ ## */
 453
 454     /* Performs any periodic activity required on ofprotos of type
 455      * 'type'.
 456      *
 457      * An ofproto provider may implement it or not, depending on whether
 458      * it needs type-level maintenance.
 459      *
 460      * Returns 0 if successful, otherwise a positive errno value. */
 461     int (*type_run)(const char *type);
 462
 463     /* Performs periodic activity required on ofprotos of type 'type'
 464      * that needs to be done with the least possible latency.
 465      *
 466      * This is run multiple times per main loop.  An ofproto provider may
 467      * implement it or not, according to whether it provides a performance
 468      * boost for that ofproto implementation.
 469      *
 470      * Returns 0 if successful, otherwise a positive errno value. */
 471     int (*type_run_fast)(const char *type);
 472
 473     /* Causes the poll loop to wake up when a type 'type''s 'run'
 474      * function needs to be called, e.g. by calling the timer or fd
 475      * waiting functions in poll-loop.h.
 476      *
 477      * An ofproto provider may implement it or not, depending on whether
 478      * it needs type-level maintenance. */
 479     void (*type_wait)(const char *type);
 480
 481 /* ## --------------------------- ## */
 482 /* ## Top-Level ofproto Functions ## */
 483 /* ## --------------------------- ## */
 484
 485     /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
 486      *
 487      *
 488      * Construction
 489      * ============
 490      *
 491      * ->construct() should not modify any base members of the ofproto.  The
 492      * client will initialize the ofproto's 'ports' and 'tables' members after
 493      * construction is complete.
 494      *
 495      * When ->construct() is called, the client does not yet know how many flow
 496      * tables the datapath supports, so ofproto->n_tables will be 0 and
 497      * ofproto->tables will be NULL.  ->construct() should call
 498      * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
 499      * ofproto->tables.  Each flow table will be initially empty, so
 500      * ->construct() should delete flows from the underlying datapath, if
 501      * necessary, rather than populating the tables.
 502      *
 503      * If the ofproto knows the maximum port number that the datapath can have,
 504      * then it can call ofproto_init_max_ports().  If it does so, then the
 505      * client will ensure that the actions it allows to be used through
 506      * OpenFlow do not refer to ports above that maximum number.
 507      *
 508      * Only one ofproto instance needs to be supported for any given datapath.
 509      * If a datapath is already open as part of one "ofproto", then another
 510      * attempt to "construct" the same datapath as part of another ofproto is
 511      * allowed to fail with an error.
 512      *
 513      * ->construct() returns 0 if successful, otherwise a positive errno
 514      * value.
 515      *
 516      *
 517      * Destruction
 518      * ===========
 519      *
 520      * If 'ofproto' has any pending asynchronous operations, ->destruct()
 521      * must complete all of them by calling ofoperation_complete().
 522      *
 523      * ->destruct() must also destroy all remaining rules in the ofproto's
 524      * tables, by passing each remaining rule to ofproto_rule_delete(), and
 525      * then complete each of those deletions in turn by calling
 526      * ofoperation_complete().
 527      *
 528      * (Thus, there is a multi-step process for any rule currently being
 529      * inserted or modified at the beginning of destruction: first
 530      * ofoperation_complete() that operation, then ofproto_rule_delete() the
 531      * rule, then ofoperation_complete() the deletion operation.)
 532      *
 533      * The client will destroy the flow tables themselves after ->destruct()
 534      * returns.
 535      */
 536     struct ofproto *(*alloc)(void);
 537     int (*construct)(struct ofproto *ofproto);
 538     void (*destruct)(struct ofproto *ofproto);
 539     void (*dealloc)(struct ofproto *ofproto);
 540
 541     /* Performs any periodic activity required by 'ofproto'.  It should:
 542      *
 543      *   - Call connmgr_send_packet_in() for each received packet that missed
 544      *     in the OpenFlow flow table or that had a OFPP_CONTROLLER output
 545      *     action.
 546      *
 547      *   - Call ofproto_rule_expire() for each OpenFlow flow that has reached
 548      *     its hard_timeout or idle_timeout, to expire the flow.
 549      *
 550      *     (But rules that are part of a pending operation, e.g. rules for
 551      *     which ->pending is true, may not expire.)
 552      *
 553      * Returns 0 if successful, otherwise a positive errno value. */
 554     int (*run)(struct ofproto *ofproto);
 555
 556     /* Performs periodic activity required by 'ofproto' that needs to be done
 557      * with the least possible latency.
 558      *
 559      * This is run multiple times per main loop.  An ofproto provider may
 560      * implement it or not, according to whether it provides a performance
 561      * boost for that ofproto implementation. */
 562     int (*run_fast)(struct ofproto *ofproto);
 563
 564     /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
 565      * be called, e.g. by calling the timer or fd waiting functions in
 566      * poll-loop.h.  */
 567     void (*wait)(struct ofproto *ofproto);
 568
 569     /* Adds some memory usage statistics for the implementation of 'ofproto'
 570      * into 'usage', for use with memory_report().
 571      *
 572      * This function is optional. */
 573     void (*get_memory_usage)(const struct ofproto *ofproto,
 574                              struct simap *usage);
 575
 576     /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
 577      * This function may prepare for that, for example by clearing state in
 578      * advance.  It should *not* actually delete any "struct rule"s from
 579      * 'ofproto', only prepare for it.
 580      *
 581      * This function is optional; it's really just for optimization in case
 582      * it's cheaper to delete all the flows from your hardware in a single pass
 583      * than to do it one by one. */
 584     void (*flush)(struct ofproto *ofproto);
 585
 586     /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
 587      *
 588      * The implementation should store true in '*arp_match_ip' if the switch
 589      * supports matching IP addresses inside ARP requests and replies, false
 590      * otherwise.
 591      *
 592      * The implementation should store in '*actions' a bitmap of the supported
 593      * OpenFlow actions.  Vendor actions are not included in '*actions'. */
 594     void (*get_features)(struct ofproto *ofproto,
 595                          bool *arp_match_ip,
 596                          enum ofputil_action_bitmap *actions);
 597
 598     /* Helper for the OpenFlow OFPST_TABLE statistics request.
 599      *
 600      * The 'ots' array contains 'ofproto->n_tables' elements.  Each element is
 601      * initialized as:
 602      *
 603      *   - 'table_id' to the array index.
 604      *
 605      *   - 'name' to "table#" where # is the table ID.
 606      *
 607      *   - 'match' and 'wildcards' to OFPXMT12_MASK.
 608      *
 609      *   - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
 610      *
 611      *   - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
 612      *
 613      *   - 'metadata_match' and 'metadata_write' to UINT64_MAX.
 614      *
 615      *   - 'instructions' to OFPIT11_ALL.
 616      *
 617      *   - 'config' to OFPTC11_TABLE_MISS_MASK.
 618      *
 619      *   - 'max_entries' to 1,000,000.
 620      *
 621      *   - 'active_count' to the classifier_count() for the table.
 622      *
 623      *   - 'lookup_count' and 'matched_count' to 0.
 624      *
 625      * The implementation should update any members in each element for which
 626      * it has better values:
 627      *
 628      *   - 'name' to a more meaningful name.
 629      *
 630      *   - 'wildcards' to the set of wildcards actually supported by the table
 631      *     (if it doesn't support all OpenFlow wildcards).
 632      *
 633      *   - 'instructions' to set the instructions actually supported by
 634      *     the table.
 635      *
 636      *   - 'write_actions' to set the write actions actually supported by
 637      *     the table (if it doesn't support all OpenFlow actions).
 638      *
 639      *   - 'apply_actions' to set the apply actions actually supported by
 640      *     the table (if it doesn't support all OpenFlow actions).
 641      *
 642      *   - 'write_setfields' to set the write setfields actually supported by
 643      *     the table.
 644      *
 645      *   - 'apply_setfields' to set the apply setfields actually supported by
 646      *     the table.
 647      *
 648      *   - 'max_entries' to the maximum number of flows actually supported by
 649      *     the hardware.
 650      *
 651      *   - 'lookup_count' to the number of packets looked up in this flow table
 652      *     so far.
 653      *
 654      *   - 'matched_count' to the number of packets looked up in this flow
 655      *     table so far that matched one of the flow entries.
 656      *
 657      * All of the members of struct ofp12_table_stats are in network byte
 658      * order.
 659      */
 660     void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
 661
 662 /* ## ---------------- ## */
 663 /* ## ofport Functions ## */
 664 /* ## ---------------- ## */
 665
 666     /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
 667      *
 668      * ->port_construct() should not modify any base members of the ofport.
 669      * An ofproto implementation should use the 'ofp_port' member of
 670      * "struct ofport" as the OpenFlow port number.
 671      *
 672      * ofports are managed by the base ofproto code.  The ofproto
 673      * implementation should only create and destroy them in response to calls
 674      * to these functions.  The base ofproto code will create and destroy
 675      * ofports in the following situations:
 676      *
 677      *   - Just after the ->construct() function is called, the base ofproto
 678      *     iterates over all of the implementation's ports, using
 679      *     ->port_dump_start() and related functions, and constructs an ofport
 680      *     for each dumped port.
 681      *
 682      *   - If ->port_poll() reports that a specific port has changed, then the
 683      *     base ofproto will query that port with ->port_query_by_name() and
 684      *     construct or destruct ofports as necessary to reflect the updated
 685      *     set of ports.
 686      *
 687      *   - If ->port_poll() returns ENOBUFS to report an unspecified port set
 688      *     change, then the base ofproto will iterate over all of the
 689      *     implementation's ports, in the same way as at ofproto
 690      *     initialization, and construct and destruct ofports to reflect all of
 691      *     the changes.
 692      *
 693      * ->port_construct() returns 0 if successful, otherwise a positive errno
 694      * value.
 695      */
 696     struct ofport *(*port_alloc)(void);
 697     int (*port_construct)(struct ofport *ofport);
 698     void (*port_destruct)(struct ofport *ofport);
 699     void (*port_dealloc)(struct ofport *ofport);
 700
 701     /* Called after 'ofport->netdev' is replaced by a new netdev object.  If
 702      * the ofproto implementation uses the ofport's netdev internally, then it
 703      * should switch to using the new one.  The old one has been closed.
 704      *
 705      * An ofproto implementation that doesn't need to do anything in this
 706      * function may use a null pointer. */
 707     void (*port_modified)(struct ofport *ofport);
 708
 709     /* Called after an OpenFlow request changes a port's configuration.
 710      * 'ofport->pp.config' contains the new configuration.  'old_config'
 711      * contains the previous configuration.
 712      *
 713      * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
 714      * turn NETDEV_UP on and off, so this function doesn't have to do anything
 715      * for that bit (and it won't be called if that is the only bit that
 716      * changes). */
 717     void (*port_reconfigured)(struct ofport *ofport,
 718                               enum ofputil_port_config old_config);
 719
 720     /* Looks up a port named 'devname' in 'ofproto'.  On success, initializes
 721      * '*port' appropriately.
 722      *
 723      * The caller owns the data in 'port' and must free it with
 724      * ofproto_port_destroy() when it is no longer needed. */
 725     int (*port_query_by_name)(const struct ofproto *ofproto,
 726                               const char *devname, struct ofproto_port *port);
 727
 728     /* Attempts to add 'netdev' as a port on 'ofproto'.  Returns 0 if
 729      * successful, otherwise a positive errno value.  The caller should
 730      * inform the implementation of the OpenFlow port through the
 731      * ->port_construct() method.
 732      *
 733      * It doesn't matter whether the new port will be returned by a later call
 734      * to ->port_poll(); the implementation may do whatever is more
 735      * convenient. */
 736     int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
 737
 738     /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.  Returns
 739      * 0 if successful, otherwise a positive errno value.
 740      *
 741      * It doesn't matter whether the new port will be returned by a later call
 742      * to ->port_poll(); the implementation may do whatever is more
 743      * convenient. */
 744     int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
 745
 746     /* Get port stats */
 747     int (*port_get_stats)(const struct ofport *port,
 748                           struct netdev_stats *stats);
 749
 750     /* Port iteration functions.
 751      *
 752      * The client might not be entirely in control of the ports within an
 753      * ofproto.  Some hardware implementations, for example, might have a fixed
 754      * set of ports in a datapath.  For this reason, the client needs a way to
 755      * iterate through all the ports that are actually in a datapath.  These
 756      * functions provide that functionality.
 757      *
 758      * The 'state' pointer provides the implementation a place to
 759      * keep track of its position.  Its format is opaque to the caller.
 760      *
 761      * The ofproto provider retains ownership of the data that it stores into
 762      * ->port_dump_next()'s 'port' argument.  The data must remain valid until
 763      * at least the next call to ->port_dump_next() or ->port_dump_done() for
 764      * 'state'.  The caller will not modify or free it.
 765      *
 766      * Details
 767      * =======
 768      *
 769      * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
 770      * On success, it should return 0 and initialize '*statep' with any data
 771      * needed for iteration.  On failure, returns a positive errno value, and
 772      * the client will not call ->port_dump_next() or ->port_dump_done().
 773      *
 774      * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
 775      * 'state'.  If there is another port, it should store the port's
 776      * information into 'port' and return 0.  It should return EOF if all ports
 777      * have already been iterated.  Otherwise, on error, it should return a
 778      * positive errno value.  This function will not be called again once it
 779      * returns nonzero once for a given iteration (but the 'port_dump_done'
 780      * function will be called afterward).
 781      *
 782      * ->port_dump_done() allows the implementation to release resources used
 783      * for iteration.  The caller might decide to stop iteration in the middle
 784      * by calling this function before ->port_dump_next() returns nonzero.
 785      *
 786      * Usage Example
 787      * =============
 788      *
 789      * int error;
 790      * void *state;
 791      *
 792      * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
 793      * if (!error) {
 794      *     for (;;) {
 795      *         struct ofproto_port port;
 796      *
 797      *         error = ofproto->ofproto_class->port_dump_next(
 798      *                     ofproto, state, &port);
 799      *         if (error) {
 800      *             break;
 801      *         }
 802      *         // Do something with 'port' here (without modifying or freeing
 803      *         // any of its data).
 804      *     }
 805      *     ofproto->ofproto_class->port_dump_done(ofproto, state);
 806      * }
 807      * // 'error' is now EOF (success) or a positive errno value (failure).
 808      */
 809     int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
 810     int (*port_dump_next)(const struct ofproto *ofproto, void *state,
 811                           struct ofproto_port *port);
 812     int (*port_dump_done)(const struct ofproto *ofproto, void *state);
 813
 814     /* Polls for changes in the set of ports in 'ofproto'.  If the set of ports
 815      * in 'ofproto' has changed, then this function should do one of the
 816      * following:
 817      *
 818      * - Preferably: store the name of the device that was added to or deleted
 819      *   from 'ofproto' in '*devnamep' and return 0.  The caller is responsible
 820      *   for freeing '*devnamep' (with free()) when it no longer needs it.
 821      *
 822      * - Alternatively: return ENOBUFS, without indicating the device that was
 823      *   added or deleted.
 824      *
 825      * Occasional 'false positives', in which the function returns 0 while
 826      * indicating a device that was not actually added or deleted or returns
 827      * ENOBUFS without any change, are acceptable.
 828      *
 829      * The purpose of 'port_poll' is to let 'ofproto' know about changes made
 830      * externally to the 'ofproto' object, e.g. by a system administrator via
 831      * ovs-dpctl.  Therefore, it's OK, and even preferable, for port_poll() to
 832      * not report changes made through calls to 'port_add' or 'port_del' on the
 833      * same 'ofproto' object.  (But it's OK for it to report them too, just
 834      * slightly less efficient.)
 835      *
 836      * If the set of ports in 'ofproto' has not changed, returns EAGAIN.  May
 837      * also return other positive errno values to indicate that something has
 838      * gone wrong.
 839      *
 840      * If the set of ports in a datapath is fixed, or if the only way that the
 841      * set of ports in a datapath can change is through ->port_add() and
 842      * ->port_del(), then this function may be a null pointer.
 843      */
 844     int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
 845
 846     /* Arranges for the poll loop to wake up when ->port_poll() will return a
 847      * value other than EAGAIN.
 848      *
 849      * If the set of ports in a datapath is fixed, or if the only way that the
 850      * set of ports in a datapath can change is through ->port_add() and
 851      * ->port_del(), or if the poll loop will always wake up anyway when
 852      * ->port_poll() will return a value other than EAGAIN, then this function
 853      * may be a null pointer.
 854      */
 855     void (*port_poll_wait)(const struct ofproto *ofproto);
 856
 857     /* Checks the status of LACP negotiation for 'port'.  Returns 1 if LACP
 858      * partner information for 'port' is up-to-date, 0 if LACP partner
 859      * information is not current (generally indicating a connectivity
 860      * problem), or -1 if LACP is not enabled on 'port'.
 861      *
 862      * This function may be a null pointer if the ofproto implementation does
 863      * not support LACP. */
 864     int (*port_is_lacp_current)(const struct ofport *port);
 865
 866 /* ## ----------------------- ## */
 867 /* ## OpenFlow Rule Functions ## */
 868 /* ## ----------------------- ## */
 869
 870     /* Chooses an appropriate table for 'match' within 'ofproto'.  On
 871      * success, stores the table ID into '*table_idp' and returns 0.  On
 872      * failure, returns an OpenFlow error code.
 873      *
 874      * The choice of table should be a function of 'match' and 'ofproto''s
 875      * datapath capabilities.  It should not depend on the flows already in
 876      * 'ofproto''s flow tables.  Failure implies that an OpenFlow rule with
 877      * 'match' as its matching condition can never be inserted into 'ofproto',
 878      * even starting from an empty flow table.
 879      *
 880      * If multiple tables are candidates for inserting the flow, the function
 881      * should choose one arbitrarily (but deterministically).
 882      *
 883      * If this function is NULL then table 0 is always chosen. */
 884     enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
 885                                      const struct match *match,
 886                                      uint8_t *table_idp);
 887
 888     /* Life-cycle functions for a "struct rule".
 889      *
 890      *
 891      * Rule Life Cycle
 892      * ===============
 893      *
 894      * The life cycle of a struct rule is an elaboration of the basic life
 895      * cycle described above under "Life Cycle".
 896      *
 897      * After a rule is successfully constructed, it is then inserted.  If
 898      * insertion completes successfully, then before it is later destructed, it
 899      * is deleted.
 900      *
 901      * You can think of a rule as having the following extra steps inserted
 902      * between "Life Cycle" steps 4 and 5:
 903      *
 904      *   4.1. The client inserts the rule into the flow table, making it
 905      *        visible in flow table lookups.
 906      *
 907      *   4.2. The client calls "rule_insert".  Immediately or eventually, the
 908      *        implementation calls ofoperation_complete() to indicate that the
 909      *        insertion completed.  If the operation failed, skip to step 5.
 910      *
 911      *   4.3. The rule is now installed in the flow table.  Eventually it will
 912      *        be deleted.
 913      *
 914      *   4.4. The client removes the rule from the flow table.  It is no longer
 915      *        visible in flow table lookups.
 916      *
 917      *   4.5. The client calls "rule_delete".  Immediately or eventually, the
 918      *        implementation calls ofoperation_complete() to indicate that the
 919      *        deletion completed.  Deletion is not allowed to fail, so it must
 920      *        be successful.
 921      *
 922      *
 923      * Asynchronous Operation Support
 924      * ==============================
 925      *
 926      * The "insert" and "delete" life-cycle operations on rules can operate
 927      * asynchronously, meaning that ->rule_insert() and ->rule_delete() only
 928      * need to initiate their respective operations and do not need to wait for
 929      * them to complete before they return.  ->rule_modify_actions() also
 930      * operates asynchronously.
 931      *
 932      * An ofproto implementation reports the success or failure of an
 933      * asynchronous operation on a rule using the rule's 'pending' member,
 934      * which points to a opaque "struct ofoperation" that represents the
 935      * ongoing operation.  When the operation completes, the ofproto
 936      * implementation calls ofoperation_complete(), passing the ofoperation and
 937      * an error indication.
 938      *
 939      * Only the following contexts may call ofoperation_complete():
 940      *
 941      *   - The function called to initiate the operation, e.g. ->rule_insert()
 942      *     or ->rule_delete().  This is the best choice if the operation
 943      *     completes quickly.
 944      *
 945      *   - The implementation's ->run() function.
 946      *
 947      *   - The implementation's ->destruct() function.
 948      *
 949      * The ofproto base code updates the flow table optimistically, assuming
 950      * that the operation will probably succeed:
 951      *
 952      *   - ofproto adds the rule in the flow table before calling
 953      *     ->rule_insert().
 954      *
 955      *   - ofproto updates the rule's actions and other properties before
 956      *     calling ->rule_modify_actions().
 957      *
 958      *   - ofproto removes the rule before calling ->rule_delete().
 959      *
 960      * With one exception, when an asynchronous operation completes with an
 961      * error, ofoperation_complete() backs out the already applied changes:
 962      *
 963      *   - If adding a rule in the flow table fails, ofproto removes the new
 964      *     rule.
 965      *
 966      *   - If modifying a rule fails, ofproto restores the original actions
 967      *     (and other properties).
 968      *
 969      *   - Removing a rule is not allowed to fail.  It must always succeed.
 970      *
 971      * The ofproto base code serializes operations: if any operation is in
 972      * progress on a given rule, ofproto postpones initiating any new operation
 973      * on that rule until the pending operation completes.  Therefore, every
 974      * operation must eventually complete through a call to
 975      * ofoperation_complete() to avoid delaying new operations indefinitely
 976      * (including any OpenFlow request that affects the rule in question, even
 977      * just to query its statistics).
 978      *
 979      *
 980      * Construction
 981      * ============
 982      *
 983      * When ->rule_construct() is called, 'rule' is a new rule that is not yet
 984      * inserted into a flow table.  ->rule_construct() should initialize enough
 985      * of the rule's derived state for 'rule' to be suitable for inserting into
 986      * a flow table.  ->rule_construct() should not modify any base members of
 987      * struct rule.
 988      *
 989      * If ->rule_construct() fails (as indicated by returning a nonzero
 990      * OpenFlow error code), the ofproto base code will uninitialize and
 991      * deallocate 'rule'.  See "Rule Life Cycle" above for more details.
 992      *
 993      * ->rule_construct() may also:
 994      *
 995      *   - Validate that the datapath supports the matching rule in 'rule->cr'
 996      *     datapath.  For example, if the rule's table does not support
 997      *     registers, then it is an error if 'rule->cr' does not wildcard all
 998      *     registers.
 999      *
1000      *   - Validate that the datapath can correctly implement 'rule->ofpacts'.
1001      *
1002      * Some implementations might need to defer these tasks to ->rule_insert(),
1003      * which is also acceptable.
1004      *
1005      *
1006      * Insertion
1007      * =========
1008      *
1009      * Following successful construction, the ofproto base case inserts 'rule'
1010      * into its flow table, then it calls ->rule_insert().  ->rule_insert()
1011      * should set in motion adding the new rule to the datapath flow table.  It
1012      * must act as follows:
1013      *
1014      *   - If it completes insertion, either by succeeding or failing, it must
1015      *     call ofoperation_complete()
1016      *
1017      *   - If insertion is only partially complete, then it must return without
1018      *     calling ofoperation_complete().  Later, when the insertion is
1019      *     complete, the ->run() or ->destruct() function must call
1020      *     ofoperation_complete() to report success or failure.
1021      *
1022      * If ->rule_insert() fails, the ofproto base code will remove 'rule' from
1023      * the flow table, destruct, uninitialize, and deallocate 'rule'.  See
1024      * "Rule Life Cycle" above for more details.
1025      *
1026      *
1027      * Deletion
1028      * ========
1029      *
1030      * The ofproto base code removes 'rule' from its flow table before it calls
1031      * ->rule_delete().  ->rule_delete() should set in motion removing 'rule'
1032      * from the datapath flow table.  It must act as follows:
1033      *
1034      *   - If it completes deletion, it must call ofoperation_complete().
1035      *
1036      *   - If deletion is only partially complete, then it must return without
1037      *     calling ofoperation_complete().  Later, when the deletion is
1038      *     complete, the ->run() or ->destruct() function must call
1039      *     ofoperation_complete().
1040      *
1041      * Rule deletion must not fail.
1042      *
1043      *
1044      * Destruction
1045      * ===========
1046      *
1047      * ->rule_destruct() must uninitialize derived state.
1048      *
1049      * Rule destruction must not fail. */
1050     struct rule *(*rule_alloc)(void);
1051     enum ofperr (*rule_construct)(struct rule *rule);
1052     void (*rule_insert)(struct rule *rule);
1053     void (*rule_delete)(struct rule *rule);
1054     void (*rule_destruct)(struct rule *rule);
1055     void (*rule_dealloc)(struct rule *rule);
1056
1057     /* Obtains statistics for 'rule', storing the number of packets that have
1058      * matched it in '*packet_count' and the number of bytes in those packets
1059      * in '*byte_count'.  UINT64_MAX indicates that the packet count or byte
1060      * count is unknown. */
1061     void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1062                            uint64_t *byte_count);
1063
1064     /* Applies the actions in 'rule' to 'packet'.  (This implements sending
1065      * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1066      *
1067      * Takes ownership of 'packet' (so it should eventually free it, with
1068      * ofpbuf_delete()).
1069      *
1070      * 'flow' reflects the flow information for 'packet'.  All of the
1071      * information in 'flow' is extracted from 'packet', except for
1072      * flow->tunnel and flow->in_port, which are assigned the correct values
1073      * for the incoming packet.  The register values are zeroed.  'packet''s
1074      * header pointers (e.g. packet->l3) are appropriately initialized.
1075      *
1076      * The implementation should add the statistics for 'packet' into 'rule'.
1077      *
1078      * Returns 0 if successful, otherwise an OpenFlow error code. */
1079     enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1080                                 struct ofpbuf *packet);
1081
1082     /* When ->rule_modify_actions() is called, the caller has already replaced
1083      * the OpenFlow actions in 'rule' by a new set.  (The original actions are
1084      * in rule->pending->actions.)
1085      *
1086      * ->rule_modify_actions() should set the following in motion:
1087      *
1088      *   - Validate that the datapath can correctly implement the actions now
1089      *     in 'rule'.
1090      *
1091      *   - Update the datapath flow table with the new actions.
1092      *
1093      *   - Only if 'reset_counters' is true, reset any packet or byte counters
1094      *     associated with the rule to zero, so that rule_get_stats() will not
1095      *     longer count those packets or bytes.
1096      *
1097      * If the operation synchronously completes, ->rule_modify_actions() may
1098      * call ofoperation_complete() before it returns.  Otherwise, ->run()
1099      * should call ofoperation_complete() later, after the operation does
1100      * complete.
1101      *
1102      * If the operation fails, then the base ofproto code will restore the
1103      * original 'actions' and 'n_actions' of 'rule'.
1104      *
1105      * ->rule_modify_actions() should not modify any base members of struct
1106      * rule. */
1107     void (*rule_modify_actions)(struct rule *rule, bool reset_counters);
1108
1109     /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1110      * which takes one of the following values, with the corresponding
1111      * meanings:
1112      *
1113      *  - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1114      *    as other packets, omitting TCP and UDP port numbers (always setting
1115      *    them to 0).
1116      *
1117      *  - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1118      *    passing them through the flow table.
1119      *
1120      *  - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1121      *    passing packets through the flow table.
1122      *
1123      *  - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1124      *    except that TCP and UDP port numbers should be included in fragments
1125      *    with offset 0.
1126      *
1127      * Implementations are not required to support every mode.
1128      * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1129      *
1130      * At the time of the call to ->set_frag_handling(), the current mode is
1131      * available in 'ofproto->frag_handling'.  ->set_frag_handling() returns
1132      * true if the requested mode was set, false if it is not supported.
1133      *
1134      * Upon successful return, the caller changes 'ofproto->frag_handling' to
1135      * reflect the new mode.
1136      */
1137     bool (*set_frag_handling)(struct ofproto *ofproto,
1138                               enum ofp_config_flags frag_handling);
1139
1140     /* Implements the OpenFlow OFPT_PACKET_OUT command.  The datapath should
1141      * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1142      *
1143      * The caller retains ownership of 'packet' and of 'ofpacts', so
1144      * ->packet_out() should not modify or free them.
1145      *
1146      * This function must validate that it can correctly implement 'ofpacts'.
1147      * If not, then it should return an OpenFlow error code.
1148      *
1149      * 'flow' reflects the flow information for 'packet'.  All of the
1150      * information in 'flow' is extracted from 'packet', except for
1151      * flow->in_port (see below).  flow->tunnel and its register values are
1152      * zeroed.
1153      *
1154      * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message.  The
1155      * implementation should reject invalid flow->in_port values by returning
1156      * OFPERR_OFPBRC_BAD_PORT.  (If the implementation called
1157      * ofproto_init_max_ports(), then the client will reject these ports
1158      * itself.)  For consistency, the implementation should consider valid for
1159      * flow->in_port any value that could possibly be seen in a packet that it
1160      * passes to connmgr_send_packet_in().  Ideally, even an implementation
1161      * that never generates packet-ins (e.g. due to hardware limitations)
1162      * should still allow flow->in_port values for every possible physical port
1163      * and OFPP_LOCAL.  The only virtual ports (those above OFPP_MAX) that the
1164      * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1165      * OFPP_NONE and OFPP_CONTROLLER.  The implementation should allow both of
1166      * these, treating each of them as packets generated by the controller as
1167      * opposed to packets originating from some switch port.
1168      *
1169      * (Ordinarily the only effect of flow->in_port is on output actions that
1170      * involve the input port, such as actions that output to OFPP_IN_PORT,
1171      * OFPP_FLOOD, or OFPP_ALL.  flow->in_port can also affect Nicira extension
1172      * "resubmit" actions.)
1173      *
1174      * 'packet' is not matched against the OpenFlow flow table, so its
1175      * statistics should not be included in OpenFlow flow statistics.
1176      *
1177      * Returns 0 if successful, otherwise an OpenFlow error code. */
1178     enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1179                               const struct flow *flow,
1180                               const struct ofpact *ofpacts,
1181                               size_t ofpacts_len);
1182
1183 /* ## ------------------------- ## */
1184 /* ## OFPP_NORMAL configuration ## */
1185 /* ## ------------------------- ## */
1186
1187     /* Configures NetFlow on 'ofproto' according to the options in
1188      * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1189      *
1190      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1191      * NetFlow, as does a null pointer. */
1192     int (*set_netflow)(struct ofproto *ofproto,
1193                        const struct netflow_options *netflow_options);
1194
1195     void (*get_netflow_ids)(const struct ofproto *ofproto,
1196                             uint8_t *engine_type, uint8_t *engine_id);
1197
1198     /* Configures sFlow on 'ofproto' according to the options in
1199      * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1200      *
1201      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1202      * sFlow, as does a null pointer. */
1203     int (*set_sflow)(struct ofproto *ofproto,
1204                      const struct ofproto_sflow_options *sflow_options);
1205
1206     /* Configures IPFIX on 'ofproto' according to the options in
1207      * 'bridge_exporter_options' and the 'flow_exporters_options'
1208      * array, or turns off IPFIX if 'bridge_exporter_options' and
1209      * 'flow_exporters_options' is NULL.
1210      *
1211      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1212      * IPFIX, as does a null pointer. */
1213     int (*set_ipfix)(
1214         struct ofproto *ofproto,
1215         const struct ofproto_ipfix_bridge_exporter_options
1216             *bridge_exporter_options,
1217         const struct ofproto_ipfix_flow_exporter_options
1218             *flow_exporters_options, size_t n_flow_exporters_options);
1219
1220     /* Configures connectivity fault management on 'ofport'.
1221      *
1222      * If 'cfm_settings' is nonnull, configures CFM according to its members.
1223      *
1224      * If 'cfm_settings' is null, removes any connectivity fault management
1225      * configuration from 'ofport'.
1226      *
1227      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1228      * support CFM, as does a null pointer. */
1229     int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1230
1231     /* Checks the status of CFM configured on 'ofport'.  Returns true if the
1232      * port's CFM status was successfully stored into '*status'.  Returns false
1233      * if the port did not have CFM configured, in which case '*status' is
1234      * indeterminate.
1235      *
1236      * The caller must provide and owns '*status', but it does not own and must
1237      * not modify or free the array returned in 'status->rmps'. */
1238     bool (*get_cfm_status)(const struct ofport *ofport,
1239                            struct ofproto_cfm_status *status);
1240
1241     /* Configures BFD on 'ofport'.
1242      *
1243      * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1244      * "enable=true", removes BFD from 'ofport'.  Otherwise, configures BFD
1245      * according to 'cfg'.
1246      *
1247      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1248      * support BFD, as does a null pointer. */
1249     int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1250
1251     /* Populates 'smap' with the status of BFD on 'ofport'.  Returns 0 on
1252      * success, or a positive errno.  EOPNOTSUPP as a return value indicates
1253      * that this ofproto_class does not support BFD, as does a null pointer. */
1254     int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1255
1256     /* Configures spanning tree protocol (STP) on 'ofproto' using the
1257      * settings defined in 's'.
1258      *
1259      * If 's' is nonnull, configures STP according to its members.
1260      *
1261      * If 's' is null, removes any STP configuration from 'ofproto'.
1262      *
1263      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1264      * support STP, as does a null pointer. */
1265     int (*set_stp)(struct ofproto *ofproto,
1266                    const struct ofproto_stp_settings *s);
1267
1268     /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1269      *
1270      * Stores STP state for 'ofproto' in 's'.  If the 'enabled' member
1271      * is false, the other member values are not meaningful.
1272      *
1273      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1274      * support STP, as does a null pointer. */
1275     int (*get_stp_status)(struct ofproto *ofproto,
1276                           struct ofproto_stp_status *s);
1277
1278     /* Configures spanning tree protocol (STP) on 'ofport' using the
1279      * settings defined in 's'.
1280      *
1281      * If 's' is nonnull, configures STP according to its members.  The
1282      * caller is responsible for assigning STP port numbers (using the
1283      * 'port_num' member in the range of 1 through 255, inclusive) and
1284      * ensuring there are no duplicates.
1285      *
1286      * If 's' is null, removes any STP configuration from 'ofport'.
1287      *
1288      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1289      * support STP, as does a null pointer. */
1290     int (*set_stp_port)(struct ofport *ofport,
1291                         const struct ofproto_port_stp_settings *s);
1292
1293     /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1294      *
1295      * Stores STP state for 'ofport' in 's'.  If the 'enabled' member is
1296      * false, the other member values are not meaningful.
1297      *
1298      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1299      * support STP, as does a null pointer. */
1300     int (*get_stp_port_status)(struct ofport *ofport,
1301                                struct ofproto_port_stp_status *s);
1302
1303     /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1304      * 'queues' attached to 'ofport'.  This data is not intended to be
1305      * sufficient to implement QoS.  Instead, providers may use this
1306      * information to implement features which require knowledge of what queues
1307      * exist on a port, and some basic information about them.
1308      *
1309      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1310      * support QoS, as does a null pointer. */
1311     int (*set_queues)(struct ofport *ofport,
1312                       const struct ofproto_port_queue *queues, size_t n_qdscp);
1313
1314     /* If 's' is nonnull, this function registers a "bundle" associated with
1315      * client data pointer 'aux' in 'ofproto'.  A bundle is the same concept as
1316      * a Port in OVSDB, that is, it consists of one or more "slave" devices
1317      * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1318      * there is more than one slave, a bonding configuration.  If 'aux' is
1319      * already registered then this function updates its configuration to 's'.
1320      * Otherwise, this function registers a new bundle.
1321      *
1322      * If 's' is NULL, this function unregisters the bundle registered on
1323      * 'ofproto' associated with client data pointer 'aux'.  If no such bundle
1324      * has been registered, this has no effect.
1325      *
1326      * This function affects only the behavior of the NXAST_AUTOPATH action and
1327      * output to the OFPP_NORMAL port.  An implementation that does not support
1328      * it at all may set it to NULL or return EOPNOTSUPP.  An implementation
1329      * that supports only a subset of the functionality should implement what
1330      * it can and return 0. */
1331     int (*bundle_set)(struct ofproto *ofproto, void *aux,
1332                       const struct ofproto_bundle_settings *s);
1333
1334     /* If 'port' is part of any bundle, removes it from that bundle.  If the
1335      * bundle now has no ports, deletes the bundle.  If the bundle now has only
1336      * one port, deconfigures the bundle's bonding configuration. */
1337     void (*bundle_remove)(struct ofport *ofport);
1338
1339     /* If 's' is nonnull, this function registers a mirror associated with
1340      * client data pointer 'aux' in 'ofproto'.  A mirror is the same concept as
1341      * a Mirror in OVSDB.  If 'aux' is already registered then this function
1342      * updates its configuration to 's'.  Otherwise, this function registers a
1343      * new mirror.
1344      *
1345      * If 's' is NULL, this function unregisters the mirror registered on
1346      * 'ofproto' associated with client data pointer 'aux'.  If no such mirror
1347      * has been registered, this has no effect.
1348      *
1349      * An implementation that does not support mirroring at all may set
1350      * it to NULL or return EOPNOTSUPP.  An implementation that supports
1351      * only a subset of the functionality should implement what it can
1352      * and return 0. */
1353     int (*mirror_set)(struct ofproto *ofproto, void *aux,
1354                       const struct ofproto_mirror_settings *s);
1355
1356     /* Retrieves statistics from mirror associated with client data
1357      * pointer 'aux' in 'ofproto'.  Stores packet and byte counts in
1358      * 'packets' and 'bytes', respectively.  If a particular counter is
1359      * not supported, the appropriate argument is set to UINT64_MAX.
1360      *
1361      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1362      * support retrieving mirror statistics. */
1363     int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1364                             uint64_t *packets, uint64_t *bytes);
1365
1366     /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1367      * on which all packets are flooded, instead of using MAC learning.  If
1368      * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1369      *
1370      * This function affects only the behavior of the OFPP_NORMAL action.  An
1371      * implementation that does not support it may set it to NULL or return
1372      * EOPNOTSUPP. */
1373     int (*set_flood_vlans)(struct ofproto *ofproto,
1374                            unsigned long *flood_vlans);
1375
1376     /* Returns true if 'aux' is a registered bundle that is currently in use as
1377      * the output for a mirror. */
1378     bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1379
1380     /* When the configuration option of forward_bpdu changes, this function
1381      * will be invoked. */
1382     void (*forward_bpdu_changed)(struct ofproto *ofproto);
1383
1384     /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1385      * seconds, and the maximum number of MAC table entries to
1386      * 'max_entries'.
1387      *
1388      * An implementation that doesn't support configuring these features may
1389      * set this function to NULL or implement it as a no-op. */
1390     void (*set_mac_table_config)(struct ofproto *ofproto,
1391                                  unsigned int idle_time, size_t max_entries);
1392
1393 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1394  *
1395  * This is deprecated.  It is only for compatibility with broken device drivers
1396  * in old versions of Linux that do not properly support VLANs when VLAN
1397  * devices are not used.  When broken device drivers are no longer in
1398  * widespread use, we will delete these interfaces. */
1399
1400     /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1401      * as a VLAN splinter port for VLAN 'vid', associated with the real device
1402      * that has OpenFlow port number 'realdev_ofp_port'.
1403      *
1404      * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1405      * as a VLAN splinter port.
1406      *
1407      * This function should be NULL if an implementation does not support it.
1408      */
1409     int (*set_realdev)(struct ofport *ofport,
1410                        ofp_port_t realdev_ofp_port, int vid);
1411
1412 /* ## ------------------------ ## */
1413 /* ## OpenFlow meter functions ## */
1414 /* ## ------------------------ ## */
1415
1416     /* These functions should be NULL if an implementation does not support
1417      * them.  They must be all null or all non-null.. */
1418
1419     /* Initializes 'features' to describe the metering features supported by
1420      * 'ofproto'. */
1421     void (*meter_get_features)(const struct ofproto *ofproto,
1422                                struct ofputil_meter_features *features);
1423
1424     /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'.  On
1425      * success the function must store a provider meter ID other than
1426      * UINT32_MAX in '*id'.  All further references to the meter will be made
1427      * with the returned provider meter id rather than the OpenFlow meter id.
1428      * The caller does not try to interpret the provider meter id, giving the
1429      * implementation the freedom to either use the OpenFlow meter_id value
1430      * provided in the meter configuration, or any other value suitable for the
1431      * implementation.
1432      *
1433      * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1434      * with that meter provider ID to have configuration 'config'.  On failure,
1435      * the existing meter configuration is left intact.  Regardless of success,
1436      * any change to '*id' updates the provider meter id used for this
1437      * meter. */
1438     enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1439                              const struct ofputil_meter_config *config);
1440
1441     /* Gets the meter and meter band packet and byte counts for maximum of
1442      * 'stats->n_bands' bands for the meter with provider ID 'id' within
1443      * 'ofproto'.  The caller fills in the other stats values.  The band stats
1444      * are copied to memory at 'stats->bands' provided by the caller.  The
1445      * number of returned band stats is returned in 'stats->n_bands'. */
1446     enum ofperr (*meter_get)(const struct ofproto *ofproto,
1447                              ofproto_meter_id id,
1448                              struct ofputil_meter_stats *stats);
1449
1450     /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1451      * further calls. */
1452     void (*meter_del)(struct ofproto *, ofproto_meter_id);
1453 };
1454
1455 extern const struct ofproto_class ofproto_dpif_class;
1456
1457 int ofproto_class_register(const struct ofproto_class *);
1458 int ofproto_class_unregister(const struct ofproto_class *);
1459
1460 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1461  * because it overlaps with an ongoing flow table operation that has not yet
1462  * completed.  The caller should retry the operation later.
1463  *
1464  * ofproto.c also uses this value internally for additional (similar) purposes.
1465  *
1466  * This particular value is a good choice because it is large, so that it does
1467  * not collide with any errno value, but not large enough to collide with an
1468  * OFPERR_* value. */
1469 enum { OFPROTO_POSTPONE = 1 << 16 };
1470 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1471
1472 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *);
1473 void ofproto_add_flow(struct ofproto *, const struct match *,
1474                       unsigned int priority,
1475                       const struct ofpact *ofpacts, size_t ofpacts_len);
1476 bool ofproto_delete_flow(struct ofproto *,
1477                          const struct match *, unsigned int priority);
1478 void ofproto_flush_flows(struct ofproto *);
1479
1480 #endif /* ofproto/ofproto-provider.h */