include/dpif.h

   1 /* Copyright (C) 2007 Board of Trustees, Leland Stanford Jr. University.
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to
   5  * deal in the Software without restriction, including without limitation the
   6  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7  * sell copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19  * IN THE SOFTWARE.
  20  */
  21
  22 #ifndef DPIF_H
  23 #define DPIF_H 1
  24
  25 /* Operations for the datapath running in the local kernel.  The interface can
  26  * generalize to multiple types of local datapaths, but the implementation only
  27  * supports the openflow kernel module via netlink. */
  28
  29 #include <stdbool.h>
  30 #include <stdint.h>
  31
  32 struct buffer;
  33 struct ofp_match;
  34
  35 /* A datapath interface.  Opaque. */
  36 struct dpif
  37 {
  38     int dp_idx;
  39     struct nl_sock *sock;
  40 };
  41
  42 int dpif_open(int dp_idx, bool subscribe, struct dpif *);
  43 void dpif_close(struct dpif *);
  44 int dpif_recv_openflow(struct dpif *, struct buffer **, bool wait);
  45 int dpif_send_openflow(struct dpif *, struct buffer *, bool wait);
  46 int dpif_add_dp(struct dpif *);
  47 int dpif_del_dp(struct dpif *);
  48 int dpif_add_port(struct dpif *, const char *netdev);
  49 int dpif_del_port(struct dpif *, const char *netdev);
  50 int dpif_show(struct dpif *);
  51 int dpif_dump_tables(struct dpif *);
  52 int dpif_dump_flows(struct dpif *, int table, struct ofp_match *);
  53 int dpif_benchmark_nl(struct dpif *, uint32_t, uint32_t);
  54
  55 #endif /* dpif.h */