9cb23ba9e625a6e704c0d828ec0f2122083bbfd2
[cascardo/ovs.git] / lib / netlink-socket.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "netlink-socket.h"
19 #include <assert.h>
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <stdlib.h>
23 #include <sys/types.h>
24 #include <unistd.h>
25 #include "coverage.h"
26 #include "dynamic-string.h"
27 #include "netlink.h"
28 #include "netlink-protocol.h"
29 #include "ofpbuf.h"
30 #include "poll-loop.h"
31 #include "socket-util.h"
32 #include "stress.h"
33 #include "vlog.h"
34
35 VLOG_DEFINE_THIS_MODULE(netlink_socket);
36
37 COVERAGE_DEFINE(netlink_overflow);
38 COVERAGE_DEFINE(netlink_received);
39 COVERAGE_DEFINE(netlink_recv_retry);
40 COVERAGE_DEFINE(netlink_send);
41 COVERAGE_DEFINE(netlink_sent);
42
43 /* Linux header file confusion causes this to be undefined. */
44 #ifndef SOL_NETLINK
45 #define SOL_NETLINK 270
46 #endif
47
48 /* A single (bad) Netlink message can in theory dump out many, many log
49  * messages, so the burst size is set quite high here to avoid missing useful
50  * information.  Also, at high logging levels we log *all* Netlink messages. */
51 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 600);
52
53 static void log_nlmsg(const char *function, int error,
54                       const void *message, size_t size, int protocol);
55 \f
56 /* Netlink sockets. */
57
58 struct nl_sock
59 {
60     int fd;
61     uint32_t pid;
62     int protocol;
63 };
64
65 static int alloc_pid(uint32_t *);
66 static void free_pid(uint32_t);
67
68 /* Creates a new netlink socket for the given netlink 'protocol'
69  * (NETLINK_ROUTE, NETLINK_GENERIC, ...).  Returns 0 and sets '*sockp' to the
70  * new socket if successful, otherwise returns a positive errno value.  */
71 int
72 nl_sock_create(int protocol, struct nl_sock **sockp)
73 {
74     struct nl_sock *sock;
75     struct sockaddr_nl local, remote;
76     int retval = 0;
77
78     *sockp = NULL;
79     sock = malloc(sizeof *sock);
80     if (sock == NULL) {
81         return ENOMEM;
82     }
83
84     sock->fd = socket(AF_NETLINK, SOCK_RAW, protocol);
85     if (sock->fd < 0) {
86         VLOG_ERR("fcntl: %s", strerror(errno));
87         goto error;
88     }
89     sock->protocol = protocol;
90
91     retval = alloc_pid(&sock->pid);
92     if (retval) {
93         goto error;
94     }
95
96     /* Bind local address as our selected pid. */
97     memset(&local, 0, sizeof local);
98     local.nl_family = AF_NETLINK;
99     local.nl_pid = sock->pid;
100     if (bind(sock->fd, (struct sockaddr *) &local, sizeof local) < 0) {
101         VLOG_ERR("bind(%"PRIu32"): %s", sock->pid, strerror(errno));
102         goto error_free_pid;
103     }
104
105     /* Bind remote address as the kernel (pid 0). */
106     memset(&remote, 0, sizeof remote);
107     remote.nl_family = AF_NETLINK;
108     remote.nl_pid = 0;
109     if (connect(sock->fd, (struct sockaddr *) &remote, sizeof remote) < 0) {
110         VLOG_ERR("connect(0): %s", strerror(errno));
111         goto error_free_pid;
112     }
113
114     *sockp = sock;
115     return 0;
116
117 error_free_pid:
118     free_pid(sock->pid);
119 error:
120     if (retval == 0) {
121         retval = errno;
122         if (retval == 0) {
123             retval = EINVAL;
124         }
125     }
126     if (sock->fd >= 0) {
127         close(sock->fd);
128     }
129     free(sock);
130     return retval;
131 }
132
133 /* Destroys netlink socket 'sock'. */
134 void
135 nl_sock_destroy(struct nl_sock *sock)
136 {
137     if (sock) {
138         close(sock->fd);
139         free_pid(sock->pid);
140         free(sock);
141     }
142 }
143
144 /* Tries to add 'sock' as a listener for 'multicast_group'.  Returns 0 if
145  * successful, otherwise a positive errno value.
146  *
147  * Multicast group numbers are always positive.
148  *
149  * It is not an error to attempt to join a multicast group to which a socket
150  * already belongs. */
151 int
152 nl_sock_join_mcgroup(struct nl_sock *sock, unsigned int multicast_group)
153 {
154     if (setsockopt(sock->fd, SOL_NETLINK, NETLINK_ADD_MEMBERSHIP,
155                    &multicast_group, sizeof multicast_group) < 0) {
156         VLOG_WARN("could not join multicast group %u (%s)",
157                   multicast_group, strerror(errno));
158         return errno;
159     }
160     return 0;
161 }
162
163 /* Tries to make 'sock' stop listening to 'multicast_group'.  Returns 0 if
164  * successful, otherwise a positive errno value.
165  *
166  * Multicast group numbers are always positive.
167  *
168  * It is not an error to attempt to leave a multicast group to which a socket
169  * does not belong.
170  *
171  * On success, reading from 'sock' will still return any messages that were
172  * received on 'multicast_group' before the group was left. */
173 int
174 nl_sock_leave_mcgroup(struct nl_sock *sock, unsigned int multicast_group)
175 {
176     if (setsockopt(sock->fd, SOL_NETLINK, NETLINK_DROP_MEMBERSHIP,
177                    &multicast_group, sizeof multicast_group) < 0) {
178         VLOG_WARN("could not leave multicast group %u (%s)",
179                   multicast_group, strerror(errno));
180         return errno;
181     }
182     return 0;
183 }
184
185 /* Tries to send 'msg', which must contain a Netlink message, to the kernel on
186  * 'sock'.  nlmsg_len in 'msg' will be finalized to match msg->size, and
187  * nlmsg_pid will be set to 'sock''s pid, before the message is sent.
188  *
189  * Returns 0 if successful, otherwise a positive errno value.  If
190  * 'wait' is true, then the send will wait until buffer space is ready;
191  * otherwise, returns EAGAIN if the 'sock' send buffer is full. */
192 int
193 nl_sock_send(struct nl_sock *sock, const struct ofpbuf *msg, bool wait)
194 {
195     struct nlmsghdr *nlmsg = nl_msg_nlmsghdr(msg);
196     int error;
197
198     nlmsg->nlmsg_len = msg->size;
199     nlmsg->nlmsg_pid = sock->pid;
200     do {
201         int retval;
202         retval = send(sock->fd, msg->data, msg->size, wait ? 0 : MSG_DONTWAIT);
203         error = retval < 0 ? errno : 0;
204     } while (error == EINTR);
205     log_nlmsg(__func__, error, msg->data, msg->size, sock->protocol);
206     if (!error) {
207         COVERAGE_INC(netlink_sent);
208     }
209     return error;
210 }
211
212 /* Tries to send the 'n_iov' chunks of data in 'iov' to the kernel on 'sock' as
213  * a single Netlink message.  (The message must be fully formed and not require
214  * finalization of its nlmsg_len or nlmsg_pid fields.)
215  *
216  * Returns 0 if successful, otherwise a positive errno value.  If 'wait' is
217  * true, then the send will wait until buffer space is ready; otherwise,
218  * returns EAGAIN if the 'sock' send buffer is full. */
219 int
220 nl_sock_sendv(struct nl_sock *sock, const struct iovec iov[], size_t n_iov,
221               bool wait)
222 {
223     struct msghdr msg;
224     int error;
225
226     COVERAGE_INC(netlink_send);
227     memset(&msg, 0, sizeof msg);
228     msg.msg_iov = (struct iovec *) iov;
229     msg.msg_iovlen = n_iov;
230     do {
231         int retval;
232         retval = sendmsg(sock->fd, &msg, wait ? 0 : MSG_DONTWAIT);
233         error = retval < 0 ? errno : 0;
234     } while (error == EINTR);
235     if (error != EAGAIN) {
236         log_nlmsg(__func__, error, iov[0].iov_base, iov[0].iov_len,
237                   sock->protocol);
238         if (!error) {
239             COVERAGE_INC(netlink_sent);
240         }
241     }
242     return error;
243 }
244
245 /* This stress option is useful for testing that OVS properly tolerates
246  * -ENOBUFS on NetLink sockets.  Such errors are unavoidable because they can
247  * occur if the kernel cannot temporarily allocate enough GFP_ATOMIC memory to
248  * reply to a request.  They can also occur if messages arrive on a multicast
249  * channel faster than OVS can process them. */
250 STRESS_OPTION(
251     netlink_overflow, "simulate netlink socket receive buffer overflow",
252     5, 1, -1, 100);
253
254 /* Tries to receive a netlink message from the kernel on 'sock'.  If
255  * successful, stores the received message into '*bufp' and returns 0.  The
256  * caller is responsible for destroying the message with ofpbuf_delete().  On
257  * failure, returns a positive errno value and stores a null pointer into
258  * '*bufp'.
259  *
260  * If 'wait' is true, nl_sock_recv waits for a message to be ready; otherwise,
261  * returns EAGAIN if the 'sock' receive buffer is empty. */
262 int
263 nl_sock_recv(struct nl_sock *sock, struct ofpbuf **bufp, bool wait)
264 {
265     uint8_t tmp;
266     ssize_t bufsize = 2048;
267     ssize_t nbytes, nbytes2;
268     struct ofpbuf *buf;
269     struct nlmsghdr *nlmsghdr;
270     struct iovec iov;
271     struct msghdr msg = {
272         .msg_name = NULL,
273         .msg_namelen = 0,
274         .msg_iov = &iov,
275         .msg_iovlen = 1,
276         .msg_control = NULL,
277         .msg_controllen = 0,
278         .msg_flags = 0
279     };
280
281     buf = ofpbuf_new(bufsize);
282     *bufp = NULL;
283
284 try_again:
285     /* Attempt to read the message.  We don't know the size of the data
286      * yet, so we take a guess at 2048.  If we're wrong, we keep trying
287      * and doubling the buffer size each time.
288      */
289     nlmsghdr = ofpbuf_put_uninit(buf, bufsize);
290     iov.iov_base = nlmsghdr;
291     iov.iov_len = bufsize;
292     do {
293         nbytes = recvmsg(sock->fd, &msg, (wait ? 0 : MSG_DONTWAIT) | MSG_PEEK);
294     } while (nbytes < 0 && errno == EINTR);
295     if (nbytes < 0) {
296         ofpbuf_delete(buf);
297         return errno;
298     }
299     if (msg.msg_flags & MSG_TRUNC) {
300         COVERAGE_INC(netlink_recv_retry);
301         bufsize *= 2;
302         ofpbuf_reinit(buf, bufsize);
303         goto try_again;
304     }
305     buf->size = nbytes;
306
307     /* We successfully read the message, so recv again to clear the queue */
308     iov.iov_base = &tmp;
309     iov.iov_len = 1;
310     do {
311         nbytes2 = recvmsg(sock->fd, &msg, MSG_DONTWAIT);
312     } while (nbytes2 < 0 && errno == EINTR);
313     if (nbytes2 < 0) {
314         if (errno == ENOBUFS) {
315             /* The kernel is notifying us that a message it tried to send to us
316              * was dropped.  We have to pass this along to the caller in case
317              * it wants to retry a request.  So kill the buffer, which we can
318              * re-read next time. */
319             COVERAGE_INC(netlink_overflow);
320             ofpbuf_delete(buf);
321             return ENOBUFS;
322         } else {
323             VLOG_ERR_RL(&rl, "failed to remove nlmsg from socket: %s\n",
324                         strerror(errno));
325         }
326     }
327     if (nbytes < sizeof *nlmsghdr
328         || nlmsghdr->nlmsg_len < sizeof *nlmsghdr
329         || nlmsghdr->nlmsg_len > nbytes) {
330         VLOG_ERR_RL(&rl, "received invalid nlmsg (%zd bytes < %d)",
331                     bufsize, NLMSG_HDRLEN);
332         ofpbuf_delete(buf);
333         return EPROTO;
334     }
335
336     if (STRESS(netlink_overflow)) {
337         ofpbuf_delete(buf);
338         return ENOBUFS;
339     }
340
341     *bufp = buf;
342     log_nlmsg(__func__, 0, buf->data, buf->size, sock->protocol);
343     COVERAGE_INC(netlink_received);
344
345     return 0;
346 }
347
348 /* Sends 'request' to the kernel via 'sock' and waits for a response.  If
349  * successful, returns 0.  On failure, returns a positive errno value.
350  *
351  * If 'replyp' is nonnull, then on success '*replyp' is set to the kernel's
352  * reply, which the caller is responsible for freeing with ofpbuf_delete(), and
353  * on failure '*replyp' is set to NULL.  If 'replyp' is null, then the kernel's
354  * reply, if any, is discarded.
355  *
356  * nlmsg_len in 'msg' will be finalized to match msg->size, and nlmsg_pid will
357  * be set to 'sock''s pid, before the message is sent.  NLM_F_ACK will be set
358  * in nlmsg_flags.
359  *
360  * The caller is responsible for destroying 'request'.
361  *
362  * Bare Netlink is an unreliable transport protocol.  This function layers
363  * reliable delivery and reply semantics on top of bare Netlink.
364  *
365  * In Netlink, sending a request to the kernel is reliable enough, because the
366  * kernel will tell us if the message cannot be queued (and we will in that
367  * case put it on the transmit queue and wait until it can be delivered).
368  *
369  * Receiving the reply is the real problem: if the socket buffer is full when
370  * the kernel tries to send the reply, the reply will be dropped.  However, the
371  * kernel sets a flag that a reply has been dropped.  The next call to recv
372  * then returns ENOBUFS.  We can then re-send the request.
373  *
374  * Caveats:
375  *
376  *      1. Netlink depends on sequence numbers to match up requests and
377  *         replies.  The sender of a request supplies a sequence number, and
378  *         the reply echos back that sequence number.
379  *
380  *         This is fine, but (1) some kernel netlink implementations are
381  *         broken, in that they fail to echo sequence numbers and (2) this
382  *         function will drop packets with non-matching sequence numbers, so
383  *         that only a single request can be usefully transacted at a time.
384  *
385  *      2. Resending the request causes it to be re-executed, so the request
386  *         needs to be idempotent.
387  */
388 int
389 nl_sock_transact(struct nl_sock *sock,
390                  const struct ofpbuf *request, struct ofpbuf **replyp)
391 {
392     uint32_t seq = nl_msg_nlmsghdr(request)->nlmsg_seq;
393     struct nlmsghdr *nlmsghdr;
394     struct ofpbuf *reply;
395     int retval;
396
397     if (replyp) {
398         *replyp = NULL;
399     }
400
401     /* Ensure that we get a reply even if this message doesn't ordinarily call
402      * for one. */
403     nl_msg_nlmsghdr(request)->nlmsg_flags |= NLM_F_ACK;
404
405 send:
406     retval = nl_sock_send(sock, request, true);
407     if (retval) {
408         return retval;
409     }
410
411 recv:
412     retval = nl_sock_recv(sock, &reply, true);
413     if (retval) {
414         if (retval == ENOBUFS) {
415             COVERAGE_INC(netlink_overflow);
416             VLOG_DBG_RL(&rl, "receive buffer overflow, resending request");
417             goto send;
418         } else {
419             return retval;
420         }
421     }
422     nlmsghdr = nl_msg_nlmsghdr(reply);
423     if (seq != nlmsghdr->nlmsg_seq) {
424         VLOG_DBG_RL(&rl, "ignoring seq %"PRIu32" != expected %"PRIu32,
425                     nl_msg_nlmsghdr(reply)->nlmsg_seq, seq);
426         ofpbuf_delete(reply);
427         goto recv;
428     }
429
430     /* If the reply is an error, discard the reply and return the error code.
431      *
432      * Except: if the reply is just an acknowledgement (error code of 0), and
433      * the caller is interested in the reply (replyp != NULL), pass the reply
434      * up to the caller.  Otherwise the caller will get a return value of 0
435      * and null '*replyp', which makes unwary callers likely to segfault. */
436     if (nl_msg_nlmsgerr(reply, &retval) && (retval || !replyp)) {
437         ofpbuf_delete(reply);
438         if (retval) {
439             VLOG_DBG_RL(&rl, "received NAK error=%d (%s)",
440                         retval, strerror(retval));
441         }
442         return retval != EAGAIN ? retval : EPROTO;
443     }
444
445     if (replyp) {
446         *replyp = reply;
447     } else {
448         ofpbuf_delete(reply);
449     }
450     return 0;
451 }
452
453 /* Drain all the messages currently in 'sock''s receive queue. */
454 int
455 nl_sock_drain(struct nl_sock *sock)
456 {
457     return drain_rcvbuf(sock->fd);
458 }
459
460 /* Starts a Netlink "dump" operation, by sending 'request' to the kernel via
461  * 'sock', and initializes 'dump' to reflect the state of the operation.
462  *
463  * nlmsg_len in 'msg' will be finalized to match msg->size, and nlmsg_pid will
464  * be set to 'sock''s pid, before the message is sent.  NLM_F_DUMP and
465  * NLM_F_ACK will be set in nlmsg_flags.
466  *
467  * The properties of Netlink make dump operations reliable as long as all of
468  * the following are true:
469  *
470  *   - At most a single dump is in progress at a time on a given nl_sock.
471  *
472  *   - The nl_sock is not subscribed to any multicast groups.
473  *
474  *   - The nl_sock is not used to send any other messages before the dump
475  *     operation is complete.
476  *
477  * This function provides no status indication.  An error status for the entire
478  * dump operation is provided when it is completed by calling nl_dump_done().
479  *
480  * The caller is responsible for destroying 'request'.  The caller must not
481  * close 'sock' before it completes the dump operation (by calling
482  * nl_dump_done()) or before nl_dump_next() returns false, whichever comes
483  * first.
484  */
485 void
486 nl_dump_start(struct nl_dump *dump,
487               struct nl_sock *sock, const struct ofpbuf *request)
488 {
489     struct nlmsghdr *nlmsghdr = nl_msg_nlmsghdr(request);
490     nlmsghdr->nlmsg_flags |= NLM_F_DUMP | NLM_F_ACK;
491     dump->seq = nlmsghdr->nlmsg_seq;
492     dump->sock = sock;
493     dump->status = nl_sock_send(sock, request, true);
494     dump->buffer = NULL;
495 }
496
497 /* Helper function for nl_dump_next(). */
498 static int
499 nl_dump_recv(struct nl_dump *dump, struct ofpbuf **bufferp)
500 {
501     struct nlmsghdr *nlmsghdr;
502     struct ofpbuf *buffer;
503     int retval;
504
505     retval = nl_sock_recv(dump->sock, bufferp, true);
506     if (retval) {
507         return retval == EINTR ? EAGAIN : retval;
508     }
509     buffer = *bufferp;
510
511     nlmsghdr = nl_msg_nlmsghdr(buffer);
512     if (dump->seq != nlmsghdr->nlmsg_seq) {
513         VLOG_DBG_RL(&rl, "ignoring seq %"PRIu32" != expected %"PRIu32,
514                     nlmsghdr->nlmsg_seq, dump->seq);
515         return EAGAIN;
516     }
517
518     if (nl_msg_nlmsgerr(buffer, &retval)) {
519         VLOG_INFO_RL(&rl, "netlink dump request error (%s)",
520                      strerror(retval));
521         return retval && retval != EAGAIN ? retval : EPROTO;
522     }
523
524     return 0;
525 }
526
527 /* Attempts to retrieve another reply from 'dump', which must have been
528  * initialized with nl_dump_start().
529  *
530  * If successful, returns true and points 'reply->data' and 'reply->size' to
531  * the message that was retrieved.  The caller must not modify 'reply' (because
532  * it points into the middle of a larger buffer).
533  *
534  * On failure, returns false and sets 'reply->data' to NULL and 'reply->size'
535  * to 0.  Failure might indicate an actual error or merely the end of replies.
536  * An error status for the entire dump operation is provided when it is
537  * completed by calling nl_dump_done().
538  */
539 bool
540 nl_dump_next(struct nl_dump *dump, struct ofpbuf *reply)
541 {
542     struct nlmsghdr *nlmsghdr;
543
544     reply->data = NULL;
545     reply->size = 0;
546     if (dump->status) {
547         return false;
548     }
549
550     if (dump->buffer && !dump->buffer->size) {
551         ofpbuf_delete(dump->buffer);
552         dump->buffer = NULL;
553     }
554     while (!dump->buffer) {
555         int retval = nl_dump_recv(dump, &dump->buffer);
556         if (retval) {
557             ofpbuf_delete(dump->buffer);
558             dump->buffer = NULL;
559             if (retval != EAGAIN) {
560                 dump->status = retval;
561                 return false;
562             }
563         }
564     }
565
566     nlmsghdr = nl_msg_next(dump->buffer, reply);
567     if (!nlmsghdr) {
568         VLOG_WARN_RL(&rl, "netlink dump reply contains message fragment");
569         dump->status = EPROTO;
570         return false;
571     } else if (nlmsghdr->nlmsg_type == NLMSG_DONE) {
572         dump->status = EOF;
573         return false;
574     }
575
576     return true;
577 }
578
579 /* Completes Netlink dump operation 'dump', which must have been initialized
580  * with nl_dump_start().  Returns 0 if the dump operation was error-free,
581  * otherwise a positive errno value describing the problem. */
582 int
583 nl_dump_done(struct nl_dump *dump)
584 {
585     /* Drain any remaining messages that the client didn't read.  Otherwise the
586      * kernel will continue to queue them up and waste buffer space. */
587     while (!dump->status) {
588         struct ofpbuf reply;
589         if (!nl_dump_next(dump, &reply)) {
590             assert(dump->status);
591         }
592     }
593
594     ofpbuf_delete(dump->buffer);
595     return dump->status == EOF ? 0 : dump->status;
596 }
597
598 /* Causes poll_block() to wake up when any of the specified 'events' (which is
599  * a OR'd combination of POLLIN, POLLOUT, etc.) occur on 'sock'. */
600 void
601 nl_sock_wait(const struct nl_sock *sock, short int events)
602 {
603     poll_fd_wait(sock->fd, events);
604 }
605 \f
606 /* Miscellaneous.  */
607
608 static const struct nl_policy family_policy[CTRL_ATTR_MAX + 1] = {
609     [CTRL_ATTR_FAMILY_ID] = {.type = NL_A_U16},
610 };
611
612 static int do_lookup_genl_family(const char *name)
613 {
614     struct nl_sock *sock;
615     struct ofpbuf request, *reply;
616     struct nlattr *attrs[ARRAY_SIZE(family_policy)];
617     int retval;
618
619     retval = nl_sock_create(NETLINK_GENERIC, &sock);
620     if (retval) {
621         return -retval;
622     }
623
624     ofpbuf_init(&request, 0);
625     nl_msg_put_genlmsghdr(&request, 0, GENL_ID_CTRL, NLM_F_REQUEST,
626                           CTRL_CMD_GETFAMILY, 1);
627     nl_msg_put_string(&request, CTRL_ATTR_FAMILY_NAME, name);
628     retval = nl_sock_transact(sock, &request, &reply);
629     ofpbuf_uninit(&request);
630     if (retval) {
631         nl_sock_destroy(sock);
632         return -retval;
633     }
634
635     if (!nl_policy_parse(reply, NLMSG_HDRLEN + GENL_HDRLEN,
636                          family_policy, attrs, ARRAY_SIZE(family_policy))) {
637         nl_sock_destroy(sock);
638         ofpbuf_delete(reply);
639         return -EPROTO;
640     }
641
642     retval = nl_attr_get_u16(attrs[CTRL_ATTR_FAMILY_ID]);
643     if (retval == 0) {
644         retval = -EPROTO;
645     }
646     nl_sock_destroy(sock);
647     ofpbuf_delete(reply);
648     return retval;
649 }
650
651 /* If '*number' is 0, translates the given Generic Netlink family 'name' to a
652  * number and stores it in '*number'.  If successful, returns 0 and the caller
653  * may use '*number' as the family number.  On failure, returns a positive
654  * errno value and '*number' caches the errno value. */
655 int
656 nl_lookup_genl_family(const char *name, int *number)
657 {
658     if (*number == 0) {
659         *number = do_lookup_genl_family(name);
660         assert(*number != 0);
661     }
662     return *number > 0 ? 0 : -*number;
663 }
664 \f
665 /* Netlink PID.
666  *
667  * Every Netlink socket must be bound to a unique 32-bit PID.  By convention,
668  * programs that have a single Netlink socket use their Unix process ID as PID,
669  * and programs with multiple Netlink sockets add a unique per-socket
670  * identifier in the bits above the Unix process ID.
671  *
672  * The kernel has Netlink PID 0.
673  */
674
675 /* Parameters for how many bits in the PID should come from the Unix process ID
676  * and how many unique per-socket. */
677 #define SOCKET_BITS 10
678 #define MAX_SOCKETS (1u << SOCKET_BITS)
679
680 #define PROCESS_BITS (32 - SOCKET_BITS)
681 #define MAX_PROCESSES (1u << PROCESS_BITS)
682 #define PROCESS_MASK ((uint32_t) (MAX_PROCESSES - 1))
683
684 /* Bit vector of unused socket identifiers. */
685 static uint32_t avail_sockets[ROUND_UP(MAX_SOCKETS, 32)];
686
687 /* Allocates and returns a new Netlink PID. */
688 static int
689 alloc_pid(uint32_t *pid)
690 {
691     int i;
692
693     for (i = 0; i < MAX_SOCKETS; i++) {
694         if ((avail_sockets[i / 32] & (1u << (i % 32))) == 0) {
695             avail_sockets[i / 32] |= 1u << (i % 32);
696             *pid = (getpid() & PROCESS_MASK) | (i << PROCESS_BITS);
697             return 0;
698         }
699     }
700     VLOG_ERR("netlink pid space exhausted");
701     return ENOBUFS;
702 }
703
704 /* Makes the specified 'pid' available for reuse. */
705 static void
706 free_pid(uint32_t pid)
707 {
708     int sock = pid >> PROCESS_BITS;
709     assert(avail_sockets[sock / 32] & (1u << (sock % 32)));
710     avail_sockets[sock / 32] &= ~(1u << (sock % 32));
711 }
712 \f
713 static void
714 nlmsghdr_to_string(const struct nlmsghdr *h, struct ds *ds)
715 {
716     struct nlmsg_flag {
717         unsigned int bits;
718         const char *name;
719     };
720     static const struct nlmsg_flag flags[] = {
721         { NLM_F_REQUEST, "REQUEST" },
722         { NLM_F_MULTI, "MULTI" },
723         { NLM_F_ACK, "ACK" },
724         { NLM_F_ECHO, "ECHO" },
725         { NLM_F_DUMP, "DUMP" },
726         { NLM_F_ROOT, "ROOT" },
727         { NLM_F_MATCH, "MATCH" },
728         { NLM_F_ATOMIC, "ATOMIC" },
729     };
730     const struct nlmsg_flag *flag;
731     uint16_t flags_left;
732
733     ds_put_format(ds, "nl(len:%"PRIu32", type=%"PRIu16,
734                   h->nlmsg_len, h->nlmsg_type);
735     if (h->nlmsg_type == NLMSG_NOOP) {
736         ds_put_cstr(ds, "(no-op)");
737     } else if (h->nlmsg_type == NLMSG_ERROR) {
738         ds_put_cstr(ds, "(error)");
739     } else if (h->nlmsg_type == NLMSG_DONE) {
740         ds_put_cstr(ds, "(done)");
741     } else if (h->nlmsg_type == NLMSG_OVERRUN) {
742         ds_put_cstr(ds, "(overrun)");
743     } else if (h->nlmsg_type < NLMSG_MIN_TYPE) {
744         ds_put_cstr(ds, "(reserved)");
745     } else {
746         ds_put_cstr(ds, "(family-defined)");
747     }
748     ds_put_format(ds, ", flags=%"PRIx16, h->nlmsg_flags);
749     flags_left = h->nlmsg_flags;
750     for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
751         if ((flags_left & flag->bits) == flag->bits) {
752             ds_put_format(ds, "[%s]", flag->name);
753             flags_left &= ~flag->bits;
754         }
755     }
756     if (flags_left) {
757         ds_put_format(ds, "[OTHER:%"PRIx16"]", flags_left);
758     }
759     ds_put_format(ds, ", seq=%"PRIx32", pid=%"PRIu32"(%d:%d))",
760                   h->nlmsg_seq, h->nlmsg_pid,
761                   (int) (h->nlmsg_pid & PROCESS_MASK),
762                   (int) (h->nlmsg_pid >> PROCESS_BITS));
763 }
764
765 static char *
766 nlmsg_to_string(const struct ofpbuf *buffer, int protocol)
767 {
768     struct ds ds = DS_EMPTY_INITIALIZER;
769     const struct nlmsghdr *h = ofpbuf_at(buffer, 0, NLMSG_HDRLEN);
770     if (h) {
771         nlmsghdr_to_string(h, &ds);
772         if (h->nlmsg_type == NLMSG_ERROR) {
773             const struct nlmsgerr *e;
774             e = ofpbuf_at(buffer, NLMSG_HDRLEN,
775                           NLMSG_ALIGN(sizeof(struct nlmsgerr)));
776             if (e) {
777                 ds_put_format(&ds, " error(%d", e->error);
778                 if (e->error < 0) {
779                     ds_put_format(&ds, "(%s)", strerror(-e->error));
780                 }
781                 ds_put_cstr(&ds, ", in-reply-to(");
782                 nlmsghdr_to_string(&e->msg, &ds);
783                 ds_put_cstr(&ds, "))");
784             } else {
785                 ds_put_cstr(&ds, " error(truncated)");
786             }
787         } else if (h->nlmsg_type == NLMSG_DONE) {
788             int *error = ofpbuf_at(buffer, NLMSG_HDRLEN, sizeof *error);
789             if (error) {
790                 ds_put_format(&ds, " done(%d", *error);
791                 if (*error < 0) {
792                     ds_put_format(&ds, "(%s)", strerror(-*error));
793                 }
794                 ds_put_cstr(&ds, ")");
795             } else {
796                 ds_put_cstr(&ds, " done(truncated)");
797             }
798         } else if (protocol == NETLINK_GENERIC) {
799             struct genlmsghdr *genl = nl_msg_genlmsghdr(buffer);
800             if (genl) {
801                 ds_put_format(&ds, ",genl(cmd=%"PRIu8",version=%"PRIu8")",
802                               genl->cmd, genl->version);
803             }
804         }
805     } else {
806         ds_put_cstr(&ds, "nl(truncated)");
807     }
808     return ds.string;
809 }
810
811 static void
812 log_nlmsg(const char *function, int error,
813           const void *message, size_t size, int protocol)
814 {
815     struct ofpbuf buffer;
816     char *nlmsg;
817
818     if (!VLOG_IS_DBG_ENABLED()) {
819         return;
820     }
821
822     ofpbuf_use_const(&buffer, message, size);
823     nlmsg = nlmsg_to_string(&buffer, protocol);
824     VLOG_DBG_RL(&rl, "%s (%s): %s", function, strerror(error), nlmsg);
825     free(nlmsg);
826 }
827
828