lib/dpif.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 "dpif.h"
  35
  36 #include <ctype.h>
  37 #include <errno.h>
  38 #include <inttypes.h>
  39 #include <netinet/in.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42
  43 #include "buffer.h"
  44 #include "netlink.h"
  45 #include "ofp-print.h"
  46 #include "openflow-netlink.h"
  47 #include "openflow.h"
  48 #include "packets.h"
  49 #include "util.h"
  50 #include "xtoxll.h"
  51
  52 #include "vlog.h"
  53 #define THIS_MODULE VLM_dpif
  54
  55 /* The Generic Netlink family number used for OpenFlow. */
  56 static int openflow_family;
  57
  58 static int lookup_openflow_multicast_group(int dp_idx, int *multicast_group);
  59 static int send_mgmt_command(struct dpif *, int command,
  60                              const char *netdev);
  61
  62 /* Opens the local datapath numbered 'dp_idx', initializing 'dp'.  If
  63  * 'subscribe' is true, listens for asynchronous messages (packet-in, etc.)
  64  * from the datapath; otherwise, 'dp' will receive only replies to explicitly
  65  * initiated requests. */
  66 int
  67 dpif_open(int dp_idx, bool subscribe, struct dpif *dp)
  68 {
  69     struct nl_sock *sock;
  70     int multicast_group = 0;
  71     int retval;
  72
  73     retval = nl_lookup_genl_family(DP_GENL_FAMILY_NAME, &openflow_family);
  74     if (retval) {
  75         return retval;
  76     }
  77
  78     if (subscribe) {
  79         retval = lookup_openflow_multicast_group(dp_idx, &multicast_group);
  80         if (retval) {
  81             return retval;
  82         }
  83     }
  84
  85     /* Specify a large so_rcvbuf size because we occasionally need to be able
  86      * to retrieve large collections of flow records. */
  87     retval = nl_sock_create(NETLINK_GENERIC, multicast_group, 0,
  88                             4 * 1024u * 1024, &sock);
  89     if (retval) {
  90         return retval;
  91     }
  92
  93     dp->dp_idx = dp_idx;
  94     dp->sock = sock;
  95     return 0;
  96 }
  97
  98 /* Closes 'dp'. */
  99 void
 100 dpif_close(struct dpif *dp)
 101 {
 102     nl_sock_destroy(dp->sock);
 103 }
 104
 105 static const struct nl_policy openflow_policy[] = {
 106     [DP_GENL_A_DP_IDX] = { .type = NL_A_U32 },
 107     [DP_GENL_A_OPENFLOW] = { .type = NL_A_UNSPEC,
 108                               .min_len = sizeof(struct ofp_header),
 109                               .max_len = OFP_MAXLEN },
 110 };
 111
 112 /* Tries to receive an openflow message from the kernel on 'sock'.  If
 113  * successful, stores the received message into '*msgp' and returns 0.  The
 114  * caller is responsible for destroying the message with buffer_delete().  On
 115  * failure, returns a positive errno value and stores a null pointer into
 116  * '*msgp'.
 117  *
 118  * Only Netlink messages with embedded OpenFlow messages are accepted.  Other
 119  * Netlink messages provoke errors.
 120  *
 121  * If 'wait' is true, dpif_recv_openflow waits for a message to be ready;
 122  * otherwise, returns EAGAIN if the 'sock' receive buffer is empty. */
 123 int
 124 dpif_recv_openflow(struct dpif *dp, struct buffer **bufferp,
 125                         bool wait)
 126 {
 127     struct nlattr *attrs[ARRAY_SIZE(openflow_policy)];
 128     struct buffer *buffer;
 129     struct ofp_header *oh;
 130     size_t ofp_len;
 131     int retval;
 132
 133     *bufferp = NULL;
 134     do {
 135         retval = nl_sock_recv(dp->sock, &buffer, wait);
 136     } while (retval == ENOBUFS || (!retval && nl_msg_nlmsgerr(buffer, NULL)));
 137     if (retval) {
 138         if (retval != EAGAIN) {
 139             VLOG_WARN("dpif_recv_openflow: %s", strerror(retval));
 140         }
 141         return retval;
 142     }
 143
 144     if (nl_msg_genlmsghdr(buffer) == NULL) {
 145         VLOG_DBG("received packet too short for Generic Netlink");
 146         goto error;
 147     }
 148     if (nl_msg_nlmsghdr(buffer)->nlmsg_type != openflow_family) {
 149         VLOG_DBG("received type (%"PRIu16") != openflow family (%d)",
 150                  nl_msg_nlmsghdr(buffer)->nlmsg_type, openflow_family);
 151         goto error;
 152     }
 153
 154     if (!nl_policy_parse(buffer, openflow_policy, attrs,
 155                          ARRAY_SIZE(openflow_policy))) {
 156         goto error;
 157     }
 158     if (nl_attr_get_u32(attrs[DP_GENL_A_DP_IDX]) != dp->dp_idx) {
 159         VLOG_WARN("received dp_idx (%"PRIu32") differs from expected (%d)",
 160                   nl_attr_get_u32(attrs[DP_GENL_A_DP_IDX]), dp->dp_idx);
 161         goto error;
 162     }
 163
 164     oh = buffer->data = (void *) nl_attr_get(attrs[DP_GENL_A_OPENFLOW]);
 165     buffer->size = nl_attr_get_size(attrs[DP_GENL_A_OPENFLOW]);
 166     ofp_len = ntohs(oh->length);
 167     if (ofp_len != buffer->size) {
 168         VLOG_WARN("ofp_header.length %"PRIu16" != attribute length %zu\n",
 169                   ofp_len, buffer->size);
 170         buffer->size = MIN(ofp_len, buffer->size);
 171     }
 172     *bufferp = buffer;
 173     return 0;
 174
 175 error:
 176     buffer_delete(buffer);
 177     return EPROTO;
 178 }
 179
 180 /* Encapsulates 'msg', which must contain an OpenFlow message, in a Netlink
 181  * message, and sends it to the OpenFlow kernel module via 'sock'.
 182  *
 183  * Returns 0 if successful, otherwise a positive errno value.  If
 184  * 'wait' is true, then the send will wait until buffer space is ready;
 185  * otherwise, returns EAGAIN if the 'sock' send buffer is full.
 186  *
 187  * If the send is successful, then the kernel module will receive it, but there
 188  * is no guarantee that any reply will not be dropped (see nl_sock_transact()
 189  * for details).
 190  */
 191 int
 192 dpif_send_openflow(struct dpif *dp, struct buffer *buffer, bool wait)
 193 {
 194     struct buffer hdr;
 195     struct nlattr *nla;
 196     uint32_t fixed_buffer[64 / 4];
 197     struct iovec iov[3];
 198     int pad_bytes;
 199     int n_iov;
 200     int retval;
 201
 202     buffer_use(&hdr, fixed_buffer, sizeof fixed_buffer);
 203     nl_msg_put_genlmsghdr(&hdr, dp->sock, 32, openflow_family,
 204                           NLM_F_REQUEST, DP_GENL_C_OPENFLOW, 1);
 205     nl_msg_put_u32(&hdr, DP_GENL_A_DP_IDX, dp->dp_idx);
 206     nla = buffer_put_uninit(&hdr, sizeof nla);
 207     nla->nla_len = sizeof nla + buffer->size;
 208     nla->nla_type = DP_GENL_A_OPENFLOW;
 209     pad_bytes = NLA_ALIGN(nla->nla_len) - nla->nla_len;
 210     nl_msg_nlmsghdr(&hdr)->nlmsg_len = hdr.size + buffer->size + pad_bytes;
 211     n_iov = 2;
 212     iov[0].iov_base = hdr.data;
 213     iov[0].iov_len = hdr.size;
 214     iov[1].iov_base = buffer->data;
 215     iov[1].iov_len = buffer->size;
 216     if (pad_bytes) {
 217         static char zeros[NLA_ALIGNTO];
 218         n_iov++;
 219         iov[2].iov_base = zeros;
 220         iov[2].iov_len = pad_bytes;
 221     }
 222     retval = nl_sock_sendv(dp->sock, iov, n_iov, false);
 223     if (retval && retval != EAGAIN) {
 224         VLOG_WARN("dpif_send_openflow: %s", strerror(retval));
 225     }
 226     return retval;
 227 }
 228
 229 /* Creates the datapath represented by 'dp'.  Returns 0 if successful,
 230  * otherwise a positive errno value. */
 231 int
 232 dpif_add_dp(struct dpif *dp)
 233 {
 234     return send_mgmt_command(dp, DP_GENL_C_ADD_DP, NULL);
 235 }
 236
 237 /* Destroys the datapath represented by 'dp'.  Returns 0 if successful,
 238  * otherwise a positive errno value. */
 239 int
 240 dpif_del_dp(struct dpif *dp)
 241 {
 242     return send_mgmt_command(dp, DP_GENL_C_DEL_DP, NULL);
 243 }
 244
 245 /* Adds the Ethernet device named 'netdev' to this datapath.  Returns 0 if
 246  * successful, otherwise a positive errno value. */
 247 int
 248 dpif_add_port(struct dpif *dp, const char *netdev)
 249 {
 250     return send_mgmt_command(dp, DP_GENL_C_ADD_PORT, netdev);
 251 }
 252
 253 /* Removes the Ethernet device named 'netdev' from this datapath.  Returns 0
 254  * if successful, otherwise a positive errno value. */
 255 int
 256 dpif_del_port(struct dpif *dp, const char *netdev)
 257 {
 258     return send_mgmt_command(dp, DP_GENL_C_DEL_PORT, netdev);
 259 }
 260
 261 /* Tells dp to send num_packets up through netlink for benchmarking*/
 262 int
 263 dpif_benchmark_nl(struct dpif *dp, uint32_t num_packets, uint32_t packet_size)
 264 {
 265     struct buffer request;
 266     int retval;
 267
 268     buffer_init(&request, 0);
 269     nl_msg_put_genlmsghdr(&request, dp->sock, 0, openflow_family,
 270                           NLM_F_REQUEST, DP_GENL_C_BENCHMARK_NL, 1);
 271     nl_msg_put_u32(&request, DP_GENL_A_DP_IDX, dp->dp_idx);
 272     nl_msg_put_u32(&request, DP_GENL_A_NPACKETS, num_packets);
 273     nl_msg_put_u32(&request, DP_GENL_A_PSIZE, packet_size);
 274     retval = nl_sock_send(dp->sock, &request, true);
 275     buffer_uninit(&request);
 276
 277     return retval;
 278 }
 279 \f
 280 static const struct nl_policy openflow_multicast_policy[] = {
 281     [DP_GENL_A_DP_IDX] = { .type = NL_A_U32 },
 282     [DP_GENL_A_MC_GROUP] = { .type = NL_A_U32 },
 283 };
 284
 285 /* Looks up the Netlink multicast group used by datapath 'dp_idx'.  If
 286  * successful, stores the multicast group in '*multicast_group' and returns 0.
 287  * Otherwise, returns a positve errno value. */
 288 static int
 289 lookup_openflow_multicast_group(int dp_idx, int *multicast_group)
 290 {
 291     struct nl_sock *sock;
 292     struct buffer request, *reply;
 293     struct nlattr *attrs[ARRAY_SIZE(openflow_multicast_policy)];
 294     int retval;
 295
 296     retval = nl_sock_create(NETLINK_GENERIC, 0, 0, 0, &sock);
 297     if (retval) {
 298         return retval;
 299     }
 300     buffer_init(&request, 0);
 301     nl_msg_put_genlmsghdr(&request, sock, 0, openflow_family, NLM_F_REQUEST,
 302                           DP_GENL_C_QUERY_DP, 1);
 303     nl_msg_put_u32(&request, DP_GENL_A_DP_IDX, dp_idx);
 304     retval = nl_sock_transact(sock, &request, &reply);
 305     buffer_uninit(&request);
 306     if (retval) {
 307         nl_sock_destroy(sock);
 308         return retval;
 309     }
 310     if (!nl_policy_parse(reply, openflow_multicast_policy, attrs,
 311                          ARRAY_SIZE(openflow_multicast_policy))) {
 312         nl_sock_destroy(sock);
 313         buffer_delete(reply);
 314         return EPROTO;
 315     }
 316     *multicast_group = nl_attr_get_u32(attrs[DP_GENL_A_MC_GROUP]);
 317     nl_sock_destroy(sock);
 318     buffer_delete(reply);
 319
 320     return 0;
 321 }
 322
 323 /* Sends the given 'command' to datapath 'dp'.  If 'netdev' is nonnull, adds it
 324  * to the command as the port name attribute.  Returns 0 if successful,
 325  * otherwise a positive errno value. */
 326 static int
 327 send_mgmt_command(struct dpif *dp, int command, const char *netdev)
 328 {
 329     struct buffer request, *reply;
 330     int retval;
 331
 332     buffer_init(&request, 0);
 333     nl_msg_put_genlmsghdr(&request, dp->sock, 32, openflow_family,
 334                           NLM_F_REQUEST | NLM_F_ACK, command, 1);
 335     nl_msg_put_u32(&request, DP_GENL_A_DP_IDX, dp->dp_idx);
 336     if (netdev) {
 337         nl_msg_put_string(&request, DP_GENL_A_PORTNAME, netdev);
 338     }
 339     retval = nl_sock_transact(dp->sock, &request, &reply);
 340     buffer_uninit(&request);
 341     buffer_delete(reply);
 342
 343     return retval;
 344 }