Setting tag sliver-openvswitch-2.2.90-1
[sliver-openvswitch.git] / lib / netlink-socket.c
index 1463ff0..e4cc4ad 100644 (file)
@@ -31,6 +31,7 @@
 #include "ofpbuf.h"
 #include "ovs-thread.h"
 #include "poll-loop.h"
+#include "seq.h"
 #include "socket-util.h"
 #include "util.h"
 #include "vlog.h"
@@ -249,15 +250,15 @@ nl_sock_send__(struct nl_sock *sock, const struct ofpbuf *msg,
     struct nlmsghdr *nlmsg = nl_msg_nlmsghdr(msg);
     int error;
 
-    nlmsg->nlmsg_len = msg->size;
+    nlmsg->nlmsg_len = ofpbuf_size(msg);
     nlmsg->nlmsg_seq = nlmsg_seq;
     nlmsg->nlmsg_pid = sock->pid;
     do {
         int retval;
-        retval = send(sock->fd, msg->data, msg->size, wait ? 0 : MSG_DONTWAIT);
+        retval = send(sock->fd, ofpbuf_data(msg), ofpbuf_size(msg), wait ? 0 : MSG_DONTWAIT);
         error = retval < 0 ? errno : 0;
     } while (error == EINTR);
-    log_nlmsg(__func__, error, msg->data, msg->size, sock->protocol);
+    log_nlmsg(__func__, error, ofpbuf_data(msg), ofpbuf_size(msg), sock->protocol);
     if (!error) {
         COVERAGE_INC(netlink_sent);
     }
@@ -265,7 +266,7 @@ nl_sock_send__(struct nl_sock *sock, const struct ofpbuf *msg,
 }
 
 /* Tries to send 'msg', which must contain a Netlink message, to the kernel on
- * 'sock'.  nlmsg_len in 'msg' will be finalized to match msg->size, nlmsg_pid
+ * 'sock'.  nlmsg_len in 'msg' will be finalized to match ofpbuf_size(msg), nlmsg_pid
  * will be set to 'sock''s pid, and nlmsg_seq will be initialized to a fresh
  * sequence number, before the message is sent.
  *
@@ -279,7 +280,7 @@ nl_sock_send(struct nl_sock *sock, const struct ofpbuf *msg, bool wait)
 }
 
 /* Tries to send 'msg', which must contain a Netlink message, to the kernel on
- * 'sock'.  nlmsg_len in 'msg' will be finalized to match msg->size, nlmsg_pid
+ * 'sock'.  nlmsg_len in 'msg' will be finalized to match ofpbuf_size(msg), nlmsg_pid
  * will be set to 'sock''s pid, and nlmsg_seq will be initialized to
  * 'nlmsg_seq', before the message is sent.
  *
@@ -313,7 +314,7 @@ nl_sock_recv__(struct nl_sock *sock, struct ofpbuf *buf, bool wait)
     ovs_assert(buf->allocated >= sizeof *nlmsghdr);
     ofpbuf_clear(buf);
 
-    iov[0].iov_base = buf->base;
+    iov[0].iov_base = ofpbuf_base(buf);
     iov[0].iov_len = buf->allocated;
     iov[1].iov_base = tail;
     iov[1].iov_len = sizeof tail;
@@ -342,7 +343,7 @@ nl_sock_recv__(struct nl_sock *sock, struct ofpbuf *buf, bool wait)
         return E2BIG;
     }
 
-    nlmsghdr = buf->data;
+    nlmsghdr = ofpbuf_data(buf);
     if (retval < sizeof *nlmsghdr
         || nlmsghdr->nlmsg_len < sizeof *nlmsghdr
         || nlmsghdr->nlmsg_len > retval) {
@@ -351,13 +352,13 @@ nl_sock_recv__(struct nl_sock *sock, struct ofpbuf *buf, bool wait)
         return EPROTO;
     }
 
-    buf->size = MIN(retval, buf->allocated);
+    ofpbuf_set_size(buf, MIN(retval, buf->allocated));
     if (retval > buf->allocated) {
         COVERAGE_INC(netlink_recv_jumbo);
         ofpbuf_put(buf, tail, retval - buf->allocated);
     }
 
-    log_nlmsg(__func__, 0, buf->data, buf->size, sock->protocol);
+    log_nlmsg(__func__, 0, ofpbuf_data(buf), ofpbuf_size(buf), sock->protocol);
     COVERAGE_INC(netlink_received);
 
     return 0;
@@ -423,12 +424,12 @@ nl_sock_transact_multiple__(struct nl_sock *sock,
         struct nl_transaction *txn = transactions[i];
         struct nlmsghdr *nlmsg = nl_msg_nlmsghdr(txn->request);
 
-        nlmsg->nlmsg_len = txn->request->size;
+        nlmsg->nlmsg_len = ofpbuf_size(txn->request);
         nlmsg->nlmsg_seq = base_seq + i;
         nlmsg->nlmsg_pid = sock->pid;
 
-        iovs[i].iov_base = txn->request->data;
-        iovs[i].iov_len = txn->request->size;
+        iovs[i].iov_base = ofpbuf_data(txn->request);
+        iovs[i].iov_len = ofpbuf_size(txn->request);
     }
 
     memset(&msg, 0, sizeof msg);
@@ -441,7 +442,7 @@ nl_sock_transact_multiple__(struct nl_sock *sock,
     for (i = 0; i < n; i++) {
         struct nl_transaction *txn = transactions[i];
 
-        log_nlmsg(__func__, error, txn->request->data, txn->request->size,
+        log_nlmsg(__func__, error, ofpbuf_data(txn->request), ofpbuf_size(txn->request),
                   sock->protocol);
     }
     if (!error) {
@@ -578,12 +579,12 @@ nl_sock_transact_multiple(struct nl_sock *sock,
 #else
         enum { MAX_BATCH_BYTES = 4096 - 512 };
 #endif
-        bytes = transactions[0]->request->size;
+        bytes = ofpbuf_size(transactions[0]->request);
         for (count = 1; count < n && count < max_batch_count; count++) {
-            if (bytes + transactions[count]->request->size > MAX_BATCH_BYTES) {
+            if (bytes + ofpbuf_size(transactions[count]->request) > MAX_BATCH_BYTES) {
                 break;
             }
-            bytes += transactions[count]->request->size;
+            bytes += ofpbuf_size(transactions[count]->request);
         }
 
         error = nl_sock_transact_multiple__(sock, transactions, count, &done);
@@ -608,7 +609,7 @@ nl_sock_transact_multiple(struct nl_sock *sock,
  * reply, if any, is discarded.
  *
  * Before the message is sent, nlmsg_len in 'request' will be finalized to
- * match msg->size, nlmsg_pid will be set to 'sock''s pid, and nlmsg_seq will
+ * match ofpbuf_size(msg), nlmsg_pid will be set to 'sock''s pid, and nlmsg_seq will
  * be initialized, NLM_F_ACK will be set in nlmsg_flags.
  *
  * The caller is responsible for destroying 'request'.
@@ -690,91 +691,110 @@ nl_sock_drain(struct nl_sock *sock)
 void
 nl_dump_start(struct nl_dump *dump, int protocol, const struct ofpbuf *request)
 {
-    ofpbuf_init(&dump->buffer, 4096);
-    dump->status = nl_pool_alloc(protocol, &dump->sock);
-    if (dump->status) {
+    int status = nl_pool_alloc(protocol, &dump->sock);
+
+    if (status) {
         return;
     }
 
     nl_msg_nlmsghdr(request)->nlmsg_flags |= NLM_F_DUMP | NLM_F_ACK;
-    dump->status = nl_sock_send__(dump->sock, request,
-                                  nl_sock_allocate_seq(dump->sock, 1), true);
-    dump->seq = nl_msg_nlmsghdr(request)->nlmsg_seq;
+    status = nl_sock_send__(dump->sock, request,
+                            nl_sock_allocate_seq(dump->sock, 1), true);
+    atomic_init(&dump->status, status << 1);
+    dump->nl_seq = nl_msg_nlmsghdr(request)->nlmsg_seq;
+    dump->status_seq = seq_create();
 }
 
-/* Helper function for nl_dump_next(). */
-static int
-nl_dump_recv(struct nl_dump *dump)
-{
-    struct nlmsghdr *nlmsghdr;
-    int retval;
-
-    retval = nl_sock_recv__(dump->sock, &dump->buffer, true);
-    if (retval) {
-        return retval == EINTR ? EAGAIN : retval;
-    }
-
-    nlmsghdr = nl_msg_nlmsghdr(&dump->buffer);
-    if (dump->seq != nlmsghdr->nlmsg_seq) {
-        VLOG_DBG_RL(&rl, "ignoring seq %#"PRIx32" != expected %#"PRIx32,
-                    nlmsghdr->nlmsg_seq, dump->seq);
-        return EAGAIN;
-    }
-
-    if (nl_msg_nlmsgerr(&dump->buffer, &retval)) {
-        VLOG_INFO_RL(&rl, "netlink dump request error (%s)",
-                     ovs_strerror(retval));
-        return retval && retval != EAGAIN ? retval : EPROTO;
-    }
-
-    return 0;
-}
-
-/* Attempts to retrieve another reply from 'dump', which must have been
- * initialized with nl_dump_start().
+/* Attempts to retrieve another reply from 'dump' into 'buffer'. 'dump' must
+ * have been initialized with nl_dump_start(), and 'buffer' must have been
+ * initialized. 'buffer' should be at least NL_DUMP_BUFSIZE bytes long.
  *
- * If successful, returns true and points 'reply->data' and 'reply->size' to
- * the message that was retrieved.  The caller must not modify 'reply' (because
- * it points into the middle of a larger buffer).
+ * If successful, returns true and points 'reply->data' and 'ofpbuf_size(reply)' to
+ * the message that was retrieved. The caller must not modify 'reply' (because
+ * it points within 'buffer', which will be used by future calls to this
+ * function).
  *
- * On failure, returns false and sets 'reply->data' to NULL and 'reply->size'
+ * On failure, returns false and sets 'reply->data' to NULL and 'ofpbuf_size(reply)'
  * to 0.  Failure might indicate an actual error or merely the end of replies.
  * An error status for the entire dump operation is provided when it is
  * completed by calling nl_dump_done().
+ *
+ * Multiple threads may call this function, passing the same nl_dump, however
+ * each must provide independent buffers. This function may cache multiple
+ * replies in the buffer, and these will be processed before more replies are
+ * fetched. When this function returns false, other threads may continue to
+ * process replies in their buffers, but they will not fetch more replies.
  */
 bool
-nl_dump_next(struct nl_dump *dump, struct ofpbuf *reply)
+nl_dump_next(struct nl_dump *dump, struct ofpbuf *reply, struct ofpbuf *buffer)
 {
     struct nlmsghdr *nlmsghdr;
+    int error = 0;
 
-    reply->data = NULL;
-    reply->size = 0;
-    if (dump->status) {
-        return false;
-    }
+    ofpbuf_set_data(reply, NULL);
+    ofpbuf_set_size(reply, 0);
+
+    /* If 'buffer' is empty, fetch another batch of nlmsgs. */
+    while (!ofpbuf_size(buffer)) {
+        unsigned int status;
+        int retval, seq;
+
+        seq = seq_read(dump->status_seq);
+        atomic_read(&dump->status, &status);
+        if (status) {
+            return false;
+        }
 
-    while (!dump->buffer.size) {
-        int retval = nl_dump_recv(dump);
+        retval = nl_sock_recv__(dump->sock, buffer, false);
         if (retval) {
-            ofpbuf_clear(&dump->buffer);
-            if (retval != EAGAIN) {
-                dump->status = retval;
-                return false;
+            ofpbuf_clear(buffer);
+            if (retval == EAGAIN) {
+                nl_sock_wait(dump->sock, POLLIN);
+                seq_wait(dump->status_seq, seq);
+                poll_block();
+                continue;
+            } else {
+                error = retval;
+                goto exit;
             }
         }
+
+        nlmsghdr = nl_msg_nlmsghdr(buffer);
+        if (dump->nl_seq != nlmsghdr->nlmsg_seq) {
+            VLOG_DBG_RL(&rl, "ignoring seq %#"PRIx32" != expected %#"PRIx32,
+                        nlmsghdr->nlmsg_seq, dump->nl_seq);
+            ofpbuf_clear(buffer);
+            continue;
+        }
+
+        if (nl_msg_nlmsgerr(buffer, &retval) && retval) {
+            VLOG_INFO_RL(&rl, "netlink dump request error (%s)",
+                         ovs_strerror(retval));
+            error = retval == EAGAIN ? EPROTO : retval;
+            ofpbuf_clear(buffer);
+            goto exit;
+        }
     }
 
-    nlmsghdr = nl_msg_next(&dump->buffer, reply);
+    /* Fetch the next nlmsg in the current batch. */
+    nlmsghdr = nl_msg_next(buffer, reply);
     if (!nlmsghdr) {
         VLOG_WARN_RL(&rl, "netlink dump reply contains message fragment");
-        dump->status = EPROTO;
-        return false;
+        error = EPROTO;
     } else if (nlmsghdr->nlmsg_type == NLMSG_DONE) {
-        dump->status = EOF;
-        return false;
+        error = EOF;
     }
 
-    return true;
+exit:
+    if (error == EOF) {
+        unsigned int old;
+        atomic_or(&dump->status, 1, &old);
+        seq_change(dump->status_seq);
+    } else if (error) {
+        atomic_store(&dump->status, error << 1);
+        seq_change(dump->status_seq);
+    }
+    return !error;
 }
 
 /* Completes Netlink dump operation 'dump', which must have been initialized
@@ -783,19 +803,28 @@ nl_dump_next(struct nl_dump *dump, struct ofpbuf *reply)
 int
 nl_dump_done(struct nl_dump *dump)
 {
+    int status;
+
     /* Drain any remaining messages that the client didn't read.  Otherwise the
      * kernel will continue to queue them up and waste buffer space.
      *
      * XXX We could just destroy and discard the socket in this case. */
-    while (!dump->status) {
-        struct ofpbuf reply;
-        if (!nl_dump_next(dump, &reply)) {
-            ovs_assert(dump->status);
+    atomic_read(&dump->status, &status);
+    if (!status) {
+        uint64_t tmp_reply_stub[NL_DUMP_BUFSIZE / 8];
+        struct ofpbuf reply, buf;
+
+        ofpbuf_use_stub(&buf, tmp_reply_stub, sizeof tmp_reply_stub);
+        while (nl_dump_next(dump, &reply, &buf)) {
+            /* Nothing to do. */
         }
+        atomic_read(&dump->status, &status);
+        ovs_assert(status);
+        ofpbuf_uninit(&buf);
     }
     nl_pool_release(dump->sock);
-    ofpbuf_uninit(&dump->buffer);
-    return dump->status == EOF ? 0 : dump->status;
+    seq_destroy(dump->status_seq);
+    return status >> 1;
 }
 
 /* Causes poll_block() to wake up when any of the specified 'events' (which is