lib/vconn-netlink.c

   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 #include <config.h>
  35 #include "vconn.h"
  36 #include <arpa/inet.h>
  37 #include <assert.h>
  38 #include <errno.h>
  39 #include <netdb.h>
  40 #include <poll.h>
  41 #include <netinet/in.h>
  42 #include <netinet/tcp.h>
  43 #include <stdlib.h>
  44 #include <string.h>
  45 #include <unistd.h>
  46 #include "dpif.h"
  47 #include "netlink.h"
  48 #include "ofpbuf.h"
  49 #include "openflow/openflow-netlink.h"
  50 #include "openflow/openflow.h"
  51 #include "poll-loop.h"
  52 #include "socket-util.h"
  53 #include "util.h"
  54 #include "vconn-provider.h"
  55
  56 #include "vlog.h"
  57 #define THIS_MODULE VLM_VCONN_NETLINK
  58
  59 struct netlink_vconn
  60 {
  61     struct vconn vconn;
  62     struct dpif dp;
  63 };
  64
  65 static struct netlink_vconn *
  66 netlink_vconn_cast(struct vconn *vconn)
  67 {
  68     vconn_assert_class(vconn, &netlink_vconn_class);
  69     return CONTAINER_OF(vconn, struct netlink_vconn, vconn);
  70 }
  71
  72 static int
  73 netlink_open(const char *name, char *suffix, struct vconn **vconnp)
  74 {
  75     struct netlink_vconn *netlink;
  76     int dp_idx;
  77     int subscribe;
  78     int retval;
  79
  80     subscribe = 1;
  81     if (sscanf(suffix, "%d:%d", &dp_idx, &subscribe) < 1) {
  82         ofp_error(0, "%s: syntax error", name);
  83         return EAFNOSUPPORT;
  84     }
  85
  86     netlink = xmalloc(sizeof *netlink);
  87     vconn_init(&netlink->vconn, &netlink_vconn_class, 0, 0, name);
  88     retval = dpif_open(dp_idx, subscribe, &netlink->dp);
  89     if (retval) {
  90         free(netlink);
  91         *vconnp = NULL;
  92         return retval;
  93     }
  94     *vconnp = &netlink->vconn;
  95     return 0;
  96 }
  97
  98 static void
  99 netlink_close(struct vconn *vconn)
 100 {
 101     struct netlink_vconn *netlink = netlink_vconn_cast(vconn);
 102     dpif_close(&netlink->dp);
 103     free(netlink);
 104 }
 105
 106 static int
 107 netlink_recv(struct vconn *vconn, struct ofpbuf **bufferp)
 108 {
 109     struct netlink_vconn *netlink = netlink_vconn_cast(vconn);
 110     return dpif_recv_openflow(&netlink->dp, bufferp, false);
 111 }
 112
 113 static int
 114 netlink_send(struct vconn *vconn, struct ofpbuf *buffer)
 115 {
 116     struct netlink_vconn *netlink = netlink_vconn_cast(vconn);
 117     int retval = dpif_send_openflow(&netlink->dp, buffer, false);
 118     if (!retval) {
 119         ofpbuf_delete(buffer);
 120     }
 121     return retval;
 122 }
 123
 124 static void
 125 netlink_wait(struct vconn *vconn, enum vconn_wait_type wait)
 126 {
 127     struct netlink_vconn *netlink = netlink_vconn_cast(vconn);
 128     short int events = 0;
 129     switch (wait) {
 130     case WAIT_RECV:
 131         events = POLLIN;
 132         break;
 133
 134     case WAIT_SEND:
 135         events = 0;
 136         break;
 137
 138     default:
 139         NOT_REACHED();
 140     }
 141     poll_fd_wait(nl_sock_fd(netlink->dp.sock), events);
 142 }
 143
 144 struct vconn_class netlink_vconn_class = {
 145     "nl",                       /* name */
 146     netlink_open,               /* open */
 147     netlink_close,              /* close */
 148     NULL,                       /* connect */
 149     netlink_recv,               /* recv */
 150     netlink_send,               /* send */
 151     netlink_wait,               /* wait */
 152 };