2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef NETLINK_SOCKET_H
18 #define NETLINK_SOCKET_H 1
20 /* Netlink socket definitions.
22 * Netlink is a datagram-based network protocol primarily for communication
23 * between user processes and the kernel, and mainly on Linux. Netlink is
24 * specified in RFC 3549, "Linux Netlink as an IP Services Protocol".
26 * Netlink is not suitable for use in physical networks of heterogeneous
27 * machines because host byte order is used throughout.
29 * This header file defines functions for working with Netlink sockets, which
30 * are Linux-specific. For Netlink protocol definitions, see
31 * netlink-protocol.h. For helper functions for working with Netlink messages,
44 #error "netlink-socket.h is only for hosts that support Netlink sockets"
47 /* Netlink sockets. */
48 int nl_sock_create(int protocol, struct nl_sock **);
49 int nl_sock_clone(const struct nl_sock *, struct nl_sock **);
50 void nl_sock_destroy(struct nl_sock *);
52 int nl_sock_join_mcgroup(struct nl_sock *, unsigned int multicast_group);
53 int nl_sock_leave_mcgroup(struct nl_sock *, unsigned int multicast_group);
55 int nl_sock_send(struct nl_sock *, const struct ofpbuf *, bool wait);
56 int nl_sock_recv(struct nl_sock *, struct ofpbuf **, bool wait);
57 int nl_sock_transact(struct nl_sock *, const struct ofpbuf *request,
58 struct ofpbuf **reply);
60 int nl_sock_drain(struct nl_sock *);
62 void nl_sock_wait(const struct nl_sock *, short int events);
63 short int nl_sock_woke(const struct nl_sock *);
65 uint32_t nl_sock_pid(const struct nl_sock *);
67 /* Batching transactions. */
68 struct nl_transaction {
69 /* Filled in by client. */
70 struct ofpbuf *request; /* Request to send. */
72 /* Filled in by nl_sock_transact_batch(). */
73 struct ofpbuf *reply; /* Reply (NULL if reply was an error code). */
74 int error; /* Positive errno value, 0 if no error. */
77 void nl_sock_transact_multiple(struct nl_sock *,
78 struct nl_transaction **, size_t n);
82 struct nl_sock *sock; /* Socket being dumped. */
83 uint32_t seq; /* Expected nlmsg_seq for replies. */
84 struct ofpbuf *buffer; /* Receive buffer currently being iterated. */
85 int status; /* 0=OK, EOF=done, or positive errno value. */
88 void nl_dump_start(struct nl_dump *, struct nl_sock *,
89 const struct ofpbuf *request);
90 bool nl_dump_next(struct nl_dump *, struct ofpbuf *reply);
91 int nl_dump_done(struct nl_dump *);
94 int nl_lookup_genl_family(const char *name, int *number);
95 int nl_lookup_genl_mcgroup(const char *family_name, const char *group_name,
96 unsigned int *multicast_group,
97 unsigned int fallback);
99 #endif /* netlink-socket.h */