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