debian: Synchronize debian/changelog with downstream Debian changelog.
[openvswitch] / lib / netlink-socket.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
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 #ifndef NETLINK_SOCKET_H
18 #define NETLINK_SOCKET_H 1
19
20 /* Netlink socket definitions.
21  *
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".
25  *
26  * Netlink is not suitable for use in physical networks of heterogeneous
27  * machines because host byte order is used throughout.
28  *
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,
32  * see netlink.h.
33  */
34
35 #include <stdbool.h>
36 #include <stddef.h>
37 #include <stdint.h>
38 #include "ofpbuf.h"
39
40 struct nl_sock;
41
42 #ifndef HAVE_NETLINK
43 #error "netlink-socket.h is only for hosts that support Netlink sockets"
44 #endif
45
46 /* Netlink sockets. */
47 int nl_sock_create(int protocol, struct nl_sock **);
48 int nl_sock_clone(const struct nl_sock *, struct nl_sock **);
49 void nl_sock_destroy(struct nl_sock *);
50
51 int nl_sock_join_mcgroup(struct nl_sock *, unsigned int multicast_group);
52 int nl_sock_leave_mcgroup(struct nl_sock *, unsigned int multicast_group);
53
54 int nl_sock_send(struct nl_sock *, const struct ofpbuf *, bool wait);
55 int nl_sock_recv(struct nl_sock *, struct ofpbuf *, bool wait);
56 int nl_sock_transact(struct nl_sock *, const struct ofpbuf *request,
57                      struct ofpbuf **replyp);
58
59 int nl_sock_drain(struct nl_sock *);
60
61 void nl_sock_wait(const struct nl_sock *, short int events);
62 int nl_sock_fd(const struct nl_sock *);
63
64 uint32_t nl_sock_pid(const struct nl_sock *);
65
66 /* Batching transactions. */
67 struct nl_transaction {
68     /* Filled in by client. */
69     struct ofpbuf *request;     /* Request to send. */
70
71     /* The client must initialize 'reply' to one of:
72      *
73      *   - NULL, if it does not care to examine the reply.
74      *
75      *   - Otherwise, to an ofpbuf with a memory allocation of at least
76      *     NLMSG_HDRLEN bytes.
77      */
78     struct ofpbuf *reply;       /* Reply (empty if reply was an error code). */
79     int error;                  /* Positive errno value, 0 if no error. */
80 };
81
82 void nl_sock_transact_multiple(struct nl_sock *,
83                                struct nl_transaction **, size_t n);
84
85 /* Table dumping. */
86 struct nl_dump {
87     struct nl_sock *sock;       /* Socket being dumped. */
88     uint32_t seq;               /* Expected nlmsg_seq for replies. */
89     struct ofpbuf buffer;       /* Receive buffer currently being iterated. */
90     int status;                 /* 0=OK, EOF=done, or positive errno value. */
91 };
92
93 void nl_dump_start(struct nl_dump *, struct nl_sock *,
94                    const struct ofpbuf *request);
95 bool nl_dump_next(struct nl_dump *, struct ofpbuf *reply);
96 int nl_dump_done(struct nl_dump *);
97
98 /* Miscellaneous */
99 int nl_lookup_genl_family(const char *name, int *number);
100 int nl_lookup_genl_mcgroup(const char *family_name, const char *group_name,
101                            unsigned int *multicast_group,
102                            unsigned int fallback);
103
104 #endif /* netlink-socket.h */