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