lib/dpif.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34
  35 #ifndef DPIF_H
  36 #define DPIF_H 1
  37
  38 /* Operations for the datapath running in the local kernel.  The interface can
  39  * generalize to multiple types of local datapaths, but the implementation only
  40  * supports the openflow kernel module via netlink. */
  41
  42 #include <stdbool.h>
  43 #include <stdint.h>
  44
  45 struct ofpbuf;
  46 struct ofp_match;
  47
  48 /* A datapath interface.  Opaque. */
  49 struct dpif
  50 {
  51     int dp_idx;
  52     struct nl_sock *sock;
  53 };
  54
  55 int dpif_open(int dp_idx, bool subscribe, struct dpif *);
  56 void dpif_close(struct dpif *);
  57 int dpif_recv_openflow(struct dpif *, struct ofpbuf **, bool wait);
  58 int dpif_send_openflow(struct dpif *, struct ofpbuf *, bool wait);
  59 int dpif_add_dp(struct dpif *);
  60 int dpif_del_dp(struct dpif *);
  61 int dpif_add_port(struct dpif *, const char *netdev);
  62 int dpif_del_port(struct dpif *, const char *netdev);
  63
  64 #endif /* dpif.h */