aboutsummaryrefslogtreecommitdiff
path: root/lib/netlink-socket.h
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2012-04-09 15:35:29 -0700
committerBen Pfaff <blp@nicira.com>2012-04-18 20:28:48 -0700
commit72d32ac0b3a1358cb36cf43f15ee7c026be36d2c (patch)
treea031af06500b11fb4bddfa81f17af9916f632ba9 /lib/netlink-socket.h
parent8843668ae593f51b3bf4ab189fa218c40f0f0e33 (diff)
netlink-socket: Make caller provide message receive buffers.
Typically an nl_sock client can stack-allocate the buffer for receiving a Netlink message, which provides a performance boost. Signed-off-by: Ben Pfaff <blp@nicira.com>
Diffstat (limited to 'lib/netlink-socket.h')
-rw-r--r--lib/netlink-socket.h20
1 files changed, 13 insertions, 7 deletions
diff --git a/lib/netlink-socket.h b/lib/netlink-socket.h
index 9d288bdd..02326160 100644
--- a/lib/netlink-socket.h
+++ b/lib/netlink-socket.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -35,8 +35,8 @@
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
+#include "ofpbuf.h"
-struct ofpbuf;
struct nl_sock;
#ifndef HAVE_NETLINK
@@ -52,9 +52,9 @@ int nl_sock_join_mcgroup(struct nl_sock *, unsigned int multicast_group);
int nl_sock_leave_mcgroup(struct nl_sock *, unsigned int multicast_group);
int nl_sock_send(struct nl_sock *, const struct ofpbuf *, bool wait);
-int nl_sock_recv(struct nl_sock *, struct ofpbuf **, bool wait);
+int nl_sock_recv(struct nl_sock *, struct ofpbuf *, bool wait);
int nl_sock_transact(struct nl_sock *, const struct ofpbuf *request,
- struct ofpbuf **reply);
+ struct ofpbuf **replyp);
int nl_sock_drain(struct nl_sock *);
@@ -68,8 +68,14 @@ struct nl_transaction {
/* Filled in by client. */
struct ofpbuf *request; /* Request to send. */
- /* Filled in by nl_sock_transact_batch(). */
- struct ofpbuf *reply; /* Reply (NULL if reply was an error code). */
+ /* The client must initialize 'reply' to one of:
+ *
+ * - NULL, if it does not care to examine the reply.
+ *
+ * - Otherwise, to an ofpbuf with a memory allocation of at least
+ * NLMSG_HDRLEN bytes.
+ */
+ struct ofpbuf *reply; /* Reply (empty if reply was an error code). */
int error; /* Positive errno value, 0 if no error. */
};
@@ -80,7 +86,7 @@ void nl_sock_transact_multiple(struct nl_sock *,
struct nl_dump {
struct nl_sock *sock; /* Socket being dumped. */
uint32_t seq; /* Expected nlmsg_seq for replies. */
- struct ofpbuf *buffer; /* Receive buffer currently being iterated. */
+ struct ofpbuf buffer; /* Receive buffer currently being iterated. */
int status; /* 0=OK, EOF=done, or positive errno value. */
};