ofproto/private.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   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_PRIVATE_H
  18 #define OFPROTO_PRIVATE_H 1
  19
  20 /* Definitions for use within ofproto. */
  21
  22 #include "ofproto/ofproto.h"
  23 #include "classifier.h"
  24 #include "list.h"
  25 #include "shash.h"
  26 #include "timeval.h"
  27
  28 /* An OpenFlow switch.
  29  *
  30  * With few exceptions, ofproto implementations may look at these fields but
  31  * should not modify them. */
  32 struct ofproto {
  33     const struct ofproto_class *ofproto_class;
  34     char *type;                 /* Datapath type. */
  35     char *name;                 /* Datapath name. */
  36     struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
  37
  38     /* Settings. */
  39     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
  40     uint64_t datapath_id;       /* Datapath ID. */
  41     char *mfr_desc;             /* Manufacturer. */
  42     char *hw_desc;              /* Hardware. */
  43     char *sw_desc;              /* Software version. */
  44     char *serial_desc;          /* Serial number. */
  45     char *dp_desc;              /* Datapath description. */
  46
  47     /* Datapath. */
  48     struct hmap ports;          /* Contains "struct ofport"s. */
  49     struct shash port_by_name;
  50
  51     /* Flow tables. */
  52     struct classifier *tables;  /* Each classifier contains "struct rule"s. */
  53     int n_tables;
  54
  55     /* OpenFlow connections. */
  56     struct connmgr *connmgr;
  57 };
  58
  59 struct ofproto *ofproto_lookup(const char *name);
  60 struct ofport *ofproto_get_port(const struct ofproto *, uint16_t ofp_port);
  61
  62 /* An OpenFlow port within a "struct ofproto".
  63  *
  64  * With few exceptions, ofproto implementations may look at these fields but
  65  * should not modify them. */
  66 struct ofport {
  67     struct ofproto *ofproto;    /* The ofproto that contains this port. */
  68     struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
  69     struct netdev *netdev;
  70     struct ofp_phy_port opp;
  71     uint16_t ofp_port;          /* OpenFlow port number. */
  72     unsigned int change_seq;
  73 };
  74
  75 /* An OpenFlow flow within a "struct ofproto".
  76  *
  77  * With few exceptions, ofproto implementations may look at these fields but
  78  * should not modify them. */
  79 struct rule {
  80     struct ofproto *ofproto;     /* The ofproto that contains this rule. */
  81     struct list ofproto_node;    /* Owned by ofproto base code. */
  82     struct cls_rule cr;          /* In owning ofproto's classifier. */
  83
  84     ovs_be64 flow_cookie;        /* Controller-issued identifier. */
  85
  86     long long int created;       /* Creation time. */
  87     uint16_t idle_timeout;       /* In seconds from time of last use. */
  88     uint16_t hard_timeout;       /* In seconds from time of creation. */
  89     uint8_t table_id;            /* Index in ofproto's 'tables' array. */
  90     bool send_flow_removed;      /* Send a flow removed message? */
  91
  92     union ofp_action *actions;   /* OpenFlow actions. */
  93     int n_actions;               /* Number of elements in actions[]. */
  94 };
  95
  96 static inline struct rule *
  97 rule_from_cls_rule(const struct cls_rule *cls_rule)
  98 {
  99     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
 100 }
 101
 102 void ofproto_rule_expire(struct rule *, uint8_t reason);
 103 void ofproto_rule_destroy(struct rule *);
 104
 105 /* ofproto class structure, to be defined by each ofproto implementation.
 106  *
 107  *
 108  * Data Structures
 109  * ===============
 110  *
 111  * These functions work primarily with three different kinds of data
 112  * structures:
 113  *
 114  *   - "struct ofproto", which represents an OpenFlow switch.
 115  *
 116  *   - "struct ofport", which represents a port within an ofproto.
 117  *
 118  *   - "struct rule", which represents an OpenFlow flow within an ofproto.
 119  *
 120  * Each of these data structures contains all of the implementation-independent
 121  * generic state for the respective concept, called the "base" state.  None of
 122  * them contains any extra space for ofproto implementations to use.  Instead,
 123  * each implementation is expected to declare its own data structure that
 124  * contains an instance of the generic data structure plus additional
 125  * implementation-specific members, called the "derived" state.  The
 126  * implementation can use casts or (preferably) the CONTAINER_OF macro to
 127  * obtain access to derived state given only a pointer to the embedded generic
 128  * data structure.
 129  *
 130  *
 131  * Life Cycle
 132  * ==========
 133  *
 134  * Four stylized functions accompany each of these data structures:
 135  *
 136  *            "alloc"       "construct"       "destruct"       "dealloc"
 137  *            ------------  ----------------  ---------------  --------------
 138  *   ofproto  ->alloc       ->construct       ->destruct       ->dealloc
 139  *   ofport   ->port_alloc  ->port_construct  ->port_destruct  ->port_dealloc
 140  *   rule     ->rule_alloc  ->rule_construct  ->rule_destruct  ->rule_dealloc
 141  *
 142  * Any instance of a given data structure goes through the following life
 143  * cycle:
 144  *
 145  *   1. The client calls the "alloc" function to obtain raw memory.  If "alloc"
 146  *      fails, skip all the other steps.
 147  *
 148  *   2. The client initializes all of the data structure's base state.  If this
 149  *      fails, skip to step 7.
 150  *
 151  *   3. The client calls the "construct" function.  The implementation
 152  *      initializes derived state.  It may refer to the already-initialized
 153  *      base state.  If "construct" fails, skip to step 6.
 154  *
 155  *   4. The data structure is now initialized and in use.
 156  *
 157  *   5. When the data structure is no longer needed, the client calls the
 158  *      "destruct" function.  The implementation uninitializes derived state.
 159  *      The base state has not been uninitialized yet, so the implementation
 160  *      may still refer to it.
 161  *
 162  *   6. The client uninitializes all of the data structure's base state.
 163  *
 164  *   7. The client calls the "dealloc" to free the raw memory.  The
 165  *      implementation must not refer to base or derived state in the data
 166  *      structure, because it has already been uninitialized.
 167  *
 168  * Each "alloc" function allocates and returns a new instance of the respective
 169  * data structure.  The "alloc" function is not given any information about the
 170  * use of the new data structure, so it cannot perform much initialization.
 171  * Its purpose is just to ensure that the new data structure has enough room
 172  * for base and derived state.  It may return a null pointer if memory is not
 173  * available, in which case none of the other functions is called.
 174  *
 175  * Each "construct" function initializes derived state in its respective data
 176  * structure.  When "construct" is called, all of the base state has already
 177  * been initialized, so the "construct" function may refer to it.  The
 178  * "construct" function is allowed to fail, in which case the client calls the
 179  * "dealloc" function (but not the "destruct" function).
 180  *
 181  * Each "destruct" function uninitializes and frees derived state in its
 182  * respective data structure.  When "destruct" is called, the base state has
 183  * not yet been uninitialized, so the "destruct" function may refer to it.  The
 184  * "destruct" function is not allowed to fail.
 185  *
 186  * Each "dealloc" function frees raw memory that was allocated by the the
 187  * "alloc" function.  The memory's base and derived members might not have ever
 188  * been initialized (but if "construct" returned successfully, then it has been
 189  * "destruct"ed already).  The "dealloc" function is not allowed to fail.
 190  *
 191  *
 192  * Conventions
 193  * ===========
 194  *
 195  * Most of these functions return 0 if they are successful or a positive error
 196  * code on failure.  Depending on the function, valid error codes are either
 197  * errno values or OpenFlow error codes constructed with ofp_mkerr().
 198  *
 199  * Most of these functions are expected to execute synchronously, that is, to
 200  * block as necessary to obtain a result.  Thus, these functions may return
 201  * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
 202  * explicitly say those errors are a possibility.  We may relax this
 203  * requirement in the future if and when we encounter performance problems. */
 204 struct ofproto_class {
 205 /* ## ----------------- ## */
 206 /* ## Factory Functions ## */
 207 /* ## ----------------- ## */
 208
 209     /* Enumerates the types of all support ofproto types into 'types'.  The
 210      * caller has already initialized 'types' and other ofproto classes might
 211      * already have added names to it. */
 212     void (*enumerate_types)(struct sset *types);
 213
 214     /* Enumerates the names of all existing datapath of the specified 'type'
 215      * into 'names' 'all_dps'.  The caller has already initialized 'names' as
 216      * an empty sset.
 217      *
 218      * 'type' is one of the types enumerated by ->enumerate_types().
 219      *
 220      * Returns 0 if successful, otherwise a positive errno value.
 221      */
 222     int (*enumerate_names)(const char *type, struct sset *names);
 223
 224     /* Deletes the datapath with the specified 'type' and 'name'.  The caller
 225      * should have closed any open ofproto with this 'type' and 'name'; this
 226      * function is allowed to fail if that is not the case.
 227      *
 228      * 'type' is one of the types enumerated by ->enumerate_types().
 229      * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
 230      *
 231      * Returns 0 if successful, otherwise a positive errno value.
 232      */
 233     int (*del)(const char *type, const char *name);
 234
 235 /* ## --------------------------- ## */
 236 /* ## Top-Level ofproto Functions ## */
 237 /* ## --------------------------- ## */
 238
 239     /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
 240      *
 241      * ->construct() should not modify most base members of the ofproto.  In
 242      * particular, the client will initialize the ofproto's 'ports' member
 243      * after construction is complete.
 244      *
 245      * ->construct() should initialize the base 'n_tables' member to the number
 246      * of flow tables supported by the datapath (between 1 and 255, inclusive),
 247      * initialize the base 'tables' member with space for one classifier per
 248      * table, and initialize each classifier with classifier_init.  Each flow
 249      * table should be initially empty, so ->construct() should delete flows
 250      * from the underlying datapath, if necessary, rather than populating the
 251      * tables.
 252      *
 253      * Only one ofproto instance needs to be supported for any given datapath.
 254      * If a datapath is already open as part of one "ofproto", then another
 255      * attempt to "construct" the same datapath as part of another ofproto is
 256      * allowed to fail with an error.
 257      *
 258      * ->construct() returns 0 if successful, otherwise a positive errno
 259      * value. */
 260     struct ofproto *(*alloc)(void);
 261     int (*construct)(struct ofproto *ofproto);
 262     void (*destruct)(struct ofproto *ofproto);
 263     void (*dealloc)(struct ofproto *ofproto);
 264
 265     /* Performs any periodic activity required by 'ofproto'.  It should:
 266      *
 267      *   - Call connmgr_send_packet_in() for each received packet that missed
 268      *     in the OpenFlow flow table or that had a OFPP_CONTROLLER output
 269      *     action.
 270      *
 271      *   - Call ofproto_rule_expire() for each OpenFlow flow that has reached
 272      *     its hard_timeout or idle_timeout, to expire the flow.
 273      *
 274      * Returns 0 if successful, otherwise a positive errno value.  The ENODEV
 275      * return value specifically means that the datapath underlying 'ofproto'
 276      * has been destroyed (externally, e.g. by an admin running ovs-dpctl).
 277      */
 278     int (*run)(struct ofproto *ofproto);
 279
 280     /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
 281      * be called, e.g. by calling the timer or fd waiting functions in
 282      * poll-loop.h.  */
 283     void (*wait)(struct ofproto *ofproto);
 284
 285     /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
 286      * This function may prepare for that, for example by clearing state in
 287      * advance.  It should *not* actually delete any "struct rule"s from
 288      * 'ofproto', only prepare for it.
 289      *
 290      * This function is optional; it's really just for optimization in case
 291      * it's cheaper to delete all the flows from your hardware in a single pass
 292      * than to do it one by one. */
 293     void (*flush)(struct ofproto *ofproto);
 294
 295     /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
 296      *
 297      * The implementation should store true in '*arp_match_ip' if the switch
 298      * supports matching IP addresses inside ARP requests and replies, false
 299      * otherwise.
 300      *
 301      * The implementation should store in '*actions' a bitmap of the supported
 302      * OpenFlow actions: the bit with value (1 << n) should be set to 1 if the
 303      * implementation supports the action with value 'n', and to 0 otherwise.
 304      * For example, if the implementation supports the OFPAT_OUTPUT and
 305      * OFPAT_ENQUEUE actions, but no others, it would set '*actions' to (1 <<
 306      * OFPAT_OUTPUT) | (1 << OFPAT_ENQUEUE).  Vendor actions are not included
 307      * in '*actions'. */
 308     void (*get_features)(struct ofproto *ofproto,
 309                          bool *arp_match_ip, uint32_t *actions);
 310
 311     /* Helper for the OpenFlow OFPST_TABLE statistics request.
 312      *
 313      * The 'ots' array contains 'ofproto->n_tables' elements.  Each element is
 314      * initialized as:
 315      *
 316      *   - 'table_id' to the array index.
 317      *
 318      *   - 'name' to "table#" where # is the table ID.
 319      *
 320      *   - 'wildcards' to OFPFW_ALL.
 321      *
 322      *   - 'max_entries' to 1,000,000.
 323      *
 324      *   - 'active_count' to the classifier_count() for the table.
 325      *
 326      *   - 'lookup_count' and 'matched_count' to 0.
 327      *
 328      * The implementation should update any members in each element for which
 329      * it has better values:
 330      *
 331      *   - 'name' to a more meaningful name.
 332      *
 333      *   - 'wildcards' to the set of wildcards actually supported by the table
 334      *     (if it doesn't support all OpenFlow wildcards).
 335      *
 336      *   - 'max_entries' to the maximum number of flows actually supported by
 337      *     the hardware.
 338      *
 339      *   - 'lookup_count' to the number of packets looked up in this flow table
 340      *     so far.
 341      *
 342      *   - 'matched_count' to the number of packets looked up in this flow
 343      *     table so far that matched one of the flow entries.
 344      *
 345      * Keep in mind that all of the members of struct ofp_table_stats are in
 346      * network byte order.
 347      */
 348     void (*get_tables)(struct ofproto *ofproto, struct ofp_table_stats *ots);
 349
 350 /* ## ---------------- ## */
 351 /* ## ofport Functions ## */
 352 /* ## ---------------- ## */
 353
 354     /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
 355      *
 356      * ->port_construct() should not modify any base members of the ofport.
 357      *
 358      * ofports are managed by the base ofproto code.  The ofproto
 359      * implementation should only create and destroy them in response to calls
 360      * to these functions.  The base ofproto code will create and destroy
 361      * ofports in the following situations:
 362      *
 363      *   - Just after the ->construct() function is called, the base ofproto
 364      *     iterates over all of the implementation's ports, using
 365      *     ->port_dump_start() and related functions, and constructs an ofport
 366      *     for each dumped port.
 367      *
 368      *   - If ->port_poll() reports that a specific port has changed, then the
 369      *     base ofproto will query that port with ->port_query_by_name() and
 370      *     construct or destruct ofports as necessary to reflect the updated
 371      *     set of ports.
 372      *
 373      *   - If ->port_poll() returns ENOBUFS to report an unspecified port set
 374      *     change, then the base ofproto will iterate over all of the
 375      *     implementation's ports, in the same way as at ofproto
 376      *     initialization, and construct and destruct ofports to reflect all of
 377      *     the changes.
 378      *
 379      * ->port_construct() returns 0 if successful, otherwise a positive errno
 380      * value.
 381      */
 382     struct ofport *(*port_alloc)(void);
 383     int (*port_construct)(struct ofport *ofport);
 384     void (*port_destruct)(struct ofport *ofport);
 385     void (*port_dealloc)(struct ofport *ofport);
 386
 387     /* Called after 'ofport->netdev' is replaced by a new netdev object.  If
 388      * the ofproto implementation uses the ofport's netdev internally, then it
 389      * should switch to using the new one.  The old one has been closed.
 390      *
 391      * An ofproto implementation that doesn't need to do anything in this
 392      * function may use a null pointer. */
 393     void (*port_modified)(struct ofport *ofport);
 394
 395     /* Called after an OpenFlow OFPT_PORT_MOD request changes a port's
 396      * configuration.  'ofport->opp.config' contains the new configuration.
 397      * 'old_config' contains the previous configuration.
 398      *
 399      * The caller implements OFPPC_PORT_DOWN using netdev functions to turn
 400      * NETDEV_UP on and off, so this function doesn't have to do anything for
 401      * that bit (and it won't be called if that is the only bit that
 402      * changes). */
 403     void (*port_reconfigured)(struct ofport *ofport, ovs_be32 old_config);
 404
 405     /* Looks up a port named 'devname' in 'ofproto'.  On success, initializes
 406      * '*port' appropriately.
 407      *
 408      * The caller owns the data in 'port' and must free it with
 409      * ofproto_port_destroy() when it is no longer needed. */
 410     int (*port_query_by_name)(const struct ofproto *ofproto,
 411                               const char *devname, struct ofproto_port *port);
 412
 413     /* Attempts to add 'netdev' as a port on 'ofproto'.  Returns 0 if
 414      * successful, otherwise a positive errno value.  If successful, sets
 415      * '*ofp_portp' to the new port's port number.
 416      *
 417      * It doesn't matter whether the new port will be returned by a later call
 418      * to ->port_poll(); the implementation may do whatever is more
 419      * convenient. */
 420     int (*port_add)(struct ofproto *ofproto, struct netdev *netdev,
 421                     uint16_t *ofp_portp);
 422
 423     /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.  Returns
 424      * 0 if successful, otherwise a positive errno value.
 425      *
 426      * It doesn't matter whether the new port will be returned by a later call
 427      * to ->port_poll(); the implementation may do whatever is more
 428      * convenient. */
 429     int (*port_del)(struct ofproto *ofproto, uint16_t ofp_port);
 430
 431     /* Attempts to begin dumping the ports in 'ofproto'.  On success, returns 0
 432      * and initializes '*statep' with any data needed for iteration.  On
 433      * failure, returns a positive errno value. */
 434     int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
 435
 436     /* Attempts to retrieve another port from 'ofproto' for 'state', which was
 437      * initialized by a successful call to the 'port_dump_start' function for
 438      * 'ofproto'.  On success, stores a new ofproto_port into 'port' and
 439      * returns 0.  Returns EOF if the end of the port table has been reached,
 440      * or a positive errno value on error.  This function will not be called
 441      * again once it returns nonzero once for a given iteration (but the
 442      * 'port_dump_done' function will be called afterward).
 443      *
 444      * The ofproto provider retains ownership of the data stored in 'port'.  It
 445      * must remain valid until at least the next call to 'port_dump_next' or
 446      * 'port_dump_done' for 'state'. */
 447     int (*port_dump_next)(const struct ofproto *ofproto, void *state,
 448                           struct ofproto_port *port);
 449
 450     /* Releases resources from 'ofproto' for 'state', which was initialized by
 451      * a successful call to the 'port_dump_start' function for 'ofproto'.  */
 452     int (*port_dump_done)(const struct ofproto *ofproto, void *state);
 453
 454     /* Polls for changes in the set of ports in 'ofproto'.  If the set of ports
 455      * in 'ofproto' has changed, then this function should do one of the
 456      * following:
 457      *
 458      * - Preferably: store the name of the device that was added to or deleted
 459      *   from 'ofproto' in '*devnamep' and return 0.  The caller is responsible
 460      *   for freeing '*devnamep' (with free()) when it no longer needs it.
 461      *
 462      * - Alternatively: return ENOBUFS, without indicating the device that was
 463      *   added or deleted.
 464      *
 465      * Occasional 'false positives', in which the function returns 0 while
 466      * indicating a device that was not actually added or deleted or returns
 467      * ENOBUFS without any change, are acceptable.
 468      *
 469      * The purpose of 'port_poll' is to let 'ofproto' know about changes made
 470      * externally to the 'ofproto' object, e.g. by a system administrator via
 471      * ovs-dpctl.  Therefore, it's OK, and even preferable, for port_poll() to
 472      * not report changes made through calls to 'port_add' or 'port_del' on the
 473      * same 'ofproto' object.  (But it's OK for it to report them too, just
 474      * slightly less efficient.)
 475      *
 476      * If the set of ports in 'ofproto' has not changed, returns EAGAIN.  May
 477      * also return other positive errno values to indicate that something has
 478      * gone wrong.
 479      *
 480      * If the set of ports in a datapath is fixed, or if the only way that the
 481      * set of ports in a datapath can change is through ->port_add() and
 482      * ->port_del(), then this function may be a null pointer.
 483      */
 484     int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
 485
 486     /* Arranges for the poll loop to wake up when ->port_poll() will return a
 487      * value other than EAGAIN.
 488      *
 489      * If the set of ports in a datapath is fixed, or if the only way that the
 490      * set of ports in a datapath can change is through ->port_add() and
 491      * ->port_del(), or if the poll loop will always wake up anyway when
 492      * ->port_poll() will return a value other than EAGAIN, then this function
 493      * may be a null pointer.
 494      */
 495     void (*port_poll_wait)(const struct ofproto *ofproto);
 496
 497     /* Checks the status of LACP negotiation for 'port'.  Returns 1 if LACP
 498      * partner information for 'port' is up-to-date, 0 if LACP partner
 499      * information is not current (generally indicating a connectivity
 500      * problem), or -1 if LACP is not enabled on 'port'.
 501      *
 502      * This function may be a null pointer if the ofproto implementation does
 503      * not support LACP. */
 504     int (*port_is_lacp_current)(const struct ofport *port);
 505
 506 /* ## ----------------------- ## */
 507 /* ## OpenFlow Rule Functions ## */
 508 /* ## ----------------------- ## */
 509
 510     /* Chooses an appropriate table for 'cls_rule' within 'ofproto'.  On
 511      * success, stores the table ID into '*table_idp' and returns 0.  On
 512      * failure, returns an OpenFlow error code (as returned by ofp_mkerr()).
 513      *
 514      * The choice of table should be a function of 'cls_rule' and 'ofproto''s
 515      * datapath capabilities.  It should not depend on the flows already in
 516      * 'ofproto''s flow tables.  Failure implies that an OpenFlow rule with
 517      * 'cls_rule' as its matching condition can never be inserted into
 518      * 'ofproto', even starting from an empty flow table.
 519      *
 520      * If multiple tables are candidates for inserting the flow, the function
 521      * should choose one arbitrarily (but deterministically).
 522      *
 523      * This function will never be called for an ofproto that has only one
 524      * table, so it may be NULL in that case. */
 525     int (*rule_choose_table)(const struct ofproto *ofproto,
 526                              const struct cls_rule *cls_rule,
 527                              uint8_t *table_idp);
 528
 529     /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
 530      *
 531      * ->rule_construct() should first check whether the rule is acceptable:
 532      *
 533      *   - Validate that the matching rule in 'rule->cr' is supported by the
 534      *     datapath.  If not, then return an OpenFlow error code (as returned
 535      *     by ofp_mkerr()).
 536      *
 537      *     For example, if the datapath does not support registers, then it
 538      *     should return an error if 'rule->cr' does not wildcard all
 539      *     registers.
 540      *
 541      *   - Validate that 'rule->actions' and 'rule->n_actions' are well-formed
 542      *     OpenFlow actions that can be correctly implemented by the datapath.
 543      *     If not, then return an OpenFlow error code (as returned by
 544      *     ofp_mkerr()).
 545      *
 546      *     The validate_actions() function (in ofp-util.c) can be useful as a
 547      *     model for action validation, but it accepts all of the OpenFlow
 548      *     actions that OVS understands.  If your ofproto implementation only
 549      *     implements a subset of those, then you should implement your own
 550      *     action validation.
 551      *
 552      * If the rule is acceptable, then ->rule_construct() should modify the
 553      * flow table:
 554      *
 555      *   - If there was already a rule with exactly the same matching criteria
 556      *     and priority in the classifier, then it should destroy it (with
 557      *     ofproto_rule_destroy()).
 558      *
 559      *     To the greatest extent possible, the old rule should be destroyed
 560      *     only if inserting the new rule succeeds; that is, ->rule_construct()
 561      *     should be transactional.
 562      *
 563      *     The function classifier_find_rule_exactly() can locate such a rule.
 564      *
 565      *   - Insert the new rule into the ofproto's 'cls' classifier, and into
 566      *     the datapath flow table.
 567      *
 568      *     The function classifier_insert() inserts a rule into the classifier.
 569      *
 570      * Other than inserting 'rule->cr' into the classifier, ->rule_construct()
 571      * should not modify any base members of struct rule.
 572      *
 573      * ->rule_destruct() should remove 'rule' from the ofproto's 'cls'
 574      * classifier (e.g. with classifier_remove()) and from the datapath flow
 575      * table. */
 576     struct rule *(*rule_alloc)(void);
 577     int (*rule_construct)(struct rule *rule);
 578     void (*rule_destruct)(struct rule *rule);
 579     void (*rule_dealloc)(struct rule *rule);
 580
 581     /* Obtains statistics for 'rule', storing the number of packets that have
 582      * matched it in '*packet_count' and the number of bytes in those packets
 583      * in '*byte_count'. */
 584     void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
 585                            uint64_t *byte_count);
 586
 587     /* Applies the actions in 'rule' to 'packet'.  (This implements sending
 588      * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
 589      *
 590      * Takes ownership of 'packet' (so it should eventually free it, with
 591      * ofpbuf_delete()).
 592      *
 593      * 'flow' reflects the flow information for 'packet'.  All of the
 594      * information in 'flow' is extracted from 'packet', except for
 595      * flow->tun_id and flow->in_port, which are assigned the correct values
 596      * for the incoming packet.  The register values are zeroed.
 597      *
 598      * The statistics for 'packet' should be included in 'rule'.
 599      *
 600      * Returns 0 if successful, otherwise an OpenFlow error code (as returned
 601      * by ofp_mkerr()). */
 602     int (*rule_execute)(struct rule *rule, struct flow *flow,
 603                         struct ofpbuf *packet);
 604
 605     /* Validates that the 'n' elements in 'actions' are well-formed OpenFlow
 606      * actions that can be correctly implemented by the datapath.  If not, then
 607      * return an OpenFlow error code (as returned by ofp_mkerr()).  If so,
 608      * then update the datapath to implement the new actions and return 0.
 609      *
 610      * When this function runs, 'rule' still has its original actions.  If this
 611      * function returns 0, then the caller will update 'rule' with the new
 612      * actions and free the old ones. */
 613     int (*rule_modify_actions)(struct rule *rule,
 614                                const union ofp_action *actions, size_t n);
 615
 616     /* These functions implement the OpenFlow IP fragment handling policy.  By
 617      * default ('drop_frags' == false), an OpenFlow switch should treat IP
 618      * fragments the same way as other packets (although TCP and UDP port
 619      * numbers cannot be determined).  With 'drop_frags' == true, the switch
 620      * should drop all IP fragments without passing them through the flow
 621      * table. */
 622     bool (*get_drop_frags)(struct ofproto *ofproto);
 623     void (*set_drop_frags)(struct ofproto *ofproto, bool drop_frags);
 624
 625     /* Implements the OpenFlow OFPT_PACKET_OUT command.  The datapath should
 626      * execute the 'n_actions' in the 'actions' array on 'packet'.
 627      *
 628      * The caller retains ownership of 'packet', so ->packet_out() should not
 629      * modify or free it.
 630      *
 631      * This function must validate that the 'n_actions' elements in 'actions'
 632      * are well-formed OpenFlow actions that can be correctly implemented by
 633      * the datapath.  If not, then it should return an OpenFlow error code (as
 634      * returned by ofp_mkerr()).
 635      *
 636      * 'flow' reflects the flow information for 'packet'.  All of the
 637      * information in 'flow' is extracted from 'packet', except for
 638      * flow->in_port, which is taken from the OFPT_PACKET_OUT message.
 639      * flow->tun_id and its register values are zeroed.
 640      *
 641      * 'packet' is not matched against the OpenFlow flow table, so its
 642      * statistics should not be included in OpenFlow flow statistics.
 643      *
 644      * Returns 0 if successful, otherwise an OpenFlow error code (as returned
 645      * by ofp_mkerr()). */
 646     int (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
 647                       const struct flow *flow,
 648                       const union ofp_action *actions,
 649                       size_t n_actions);
 650
 651 /* ## ------------------------- ## */
 652 /* ## OFPP_NORMAL configuration ## */
 653 /* ## ------------------------- ## */
 654
 655     /* Configures NetFlow on 'ofproto' according to the options in
 656      * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
 657      *
 658      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
 659      * NetFlow, as does a null pointer. */
 660     int (*set_netflow)(struct ofproto *ofproto,
 661                        const struct netflow_options *netflow_options);
 662
 663     void (*get_netflow_ids)(const struct ofproto *ofproto,
 664                             uint8_t *engine_type, uint8_t *engine_id);
 665
 666     /* Configures sFlow on 'ofproto' according to the options in
 667      * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
 668      *
 669      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
 670      * sFlow, as does a null pointer. */
 671     int (*set_sflow)(struct ofproto *ofproto,
 672                      const struct ofproto_sflow_options *sflow_options);
 673
 674     /* Configures connectivity fault management on 'ofport'.
 675      *
 676      * If 'cfm_settings' is nonnull, configures CFM according to its members.
 677      *
 678      * If 'cfm_settings' is null, removes any connectivity fault management
 679      * configuration from 'ofport'.
 680      *
 681      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
 682      * support CFM, as does a null pointer. */
 683     int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
 684
 685     /* Checks the fault status of CFM configured on 'ofport'.  Returns 1 if CFM
 686      * is faulted (generally indicating a connectivity problem), 0 if CFM is
 687      * not faulted, or -1 if CFM is not enabled on 'port'
 688      *
 689      * This function may be a null pointer if the ofproto implementation does
 690      * not support CFM. */
 691     int (*get_cfm_fault)(const struct ofport *ofport);
 692
 693     /* If 's' is nonnull, this function registers a "bundle" associated with
 694      * client data pointer 'aux' in 'ofproto'.  A bundle is the same concept as
 695      * a Port in OVSDB, that is, it consists of one or more "slave" devices
 696      * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
 697      * there is more than one slave, a bonding configuration.  If 'aux' is
 698      * already registered then this function updates its configuration to 's'.
 699      * Otherwise, this function registers a new bundle.
 700      *
 701      * If 's' is NULL, this function unregisters the bundle registered on
 702      * 'ofproto' associated with client data pointer 'aux'.  If no such bundle
 703      * has been registered, this has no effect.
 704      *
 705      * This function affects only the behavior of the NXAST_AUTOPATH action and
 706      * output to the OFPP_NORMAL port.  An implementation that does not support
 707      * it at all may set it to NULL or return EOPNOTSUPP.  An implementation
 708      * that supports only a subset of the functionality should implement what
 709      * it can and return 0. */
 710     int (*bundle_set)(struct ofproto *ofproto, void *aux,
 711                       const struct ofproto_bundle_settings *s);
 712
 713     /* If 'port' is part of any bundle, removes it from that bundle.  If the
 714      * bundle now has no ports, deletes the bundle.  If the bundle now has only
 715      * one port, deconfigures the bundle's bonding configuration. */
 716     void (*bundle_remove)(struct ofport *ofport);
 717
 718     /* If 's' is nonnull, this function registers a mirror associated with
 719      * client data pointer 'aux' in 'ofproto'.  A mirror is the same concept as
 720      * a Mirror in OVSDB.  If 'aux' is already registered then this function
 721      * updates its configuration to 's'.  Otherwise, this function registers a
 722      * new mirror.
 723      *
 724      * If 's' is NULL, this function unregisters the mirror registered on
 725      * 'ofproto' associated with client data pointer 'aux'.  If no such mirror
 726      * has been registered, this has no effect.
 727      *
 728      * This function affects only the behavior of the OFPP_NORMAL action.  An
 729      * implementation that does not support it at all may set it to NULL or
 730      * return EOPNOTSUPP.  An implementation that supports only a subset of the
 731      * functionality should implement what it can and return 0. */
 732     int (*mirror_set)(struct ofproto *ofproto, void *aux,
 733                       const struct ofproto_mirror_settings *s);
 734
 735     /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
 736      * on which all packets are flooded, instead of using MAC learning.  If
 737      * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
 738      *
 739      * This function affects only the behavior of the OFPP_NORMAL action.  An
 740      * implementation that does not support it may set it to NULL or return
 741      * EOPNOTSUPP. */
 742     int (*set_flood_vlans)(struct ofproto *ofproto,
 743                            unsigned long *flood_vlans);
 744
 745     /* Returns true if 'aux' is a registered bundle that is currently in use as
 746      * the output for a mirror. */
 747     bool (*is_mirror_output_bundle)(struct ofproto *ofproto, void *aux);
 748 };
 749
 750 extern const struct ofproto_class ofproto_dpif_class;
 751
 752 int ofproto_class_register(const struct ofproto_class *);
 753 int ofproto_class_unregister(const struct ofproto_class *);
 754
 755 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
 756                       const union ofp_action *, size_t n_actions);
 757 void ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
 758 void ofproto_flush_flows(struct ofproto *);
 759
 760 #endif /* ofproto/private.h */