lib/netlink-protocol.h

   1 /*
   2  * Copyright (c) 2008, 2010, 2011, 2014 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_PROTOCOL_H
  18 #define NETLINK_PROTOCOL_H 1
  19
  20 /* Netlink protocol definitions.
  21  *
  22  * Netlink is a message framing format described in RFC 3549 and used heavily
  23  * in Linux to access the network stack.  Open vSwitch uses AF_NETLINK sockets
  24  * for this purpose on Linux.  But on all platforms, Open vSwitch uses Netlink
  25  * message framing internally for certain purposes.
  26  *
  27  * This header provides access to the Netlink message framing definitions
  28  * regardless of platform.  On Linux, it includes the proper headers directly;
  29  * on other platforms it directly defines the structures and macros itself.
  30  */
  31
  32 #include <stdint.h>
  33 #include <sys/socket.h>
  34 #include "util.h"
  35
  36 #ifdef HAVE_NETLINK
  37 #include <linux/netlink.h>
  38 #include <linux/genetlink.h>
  39
  40 #else
  41 #define NETLINK_GENERIC         16
  42
  43 /* nlmsg_flags bits. */
  44 #define NLM_F_REQUEST           0x001
  45 #define NLM_F_MULTI             0x002
  46 #define NLM_F_ACK               0x004
  47 #define NLM_F_ECHO              0x008
  48
  49 #define NLM_F_ROOT              0x100
  50 #define NLM_F_MATCH             0x200
  51 #define NLM_F_ATOMIC            0x400
  52 #define NLM_F_DUMP              (NLM_F_ROOT | NLM_F_MATCH)
  53
  54 /* nlmsg_type values. */
  55 #define NLMSG_NOOP              1
  56 #define NLMSG_ERROR             2
  57 #define NLMSG_DONE              3
  58 #define NLMSG_OVERRUN           4
  59
  60 #define NLMSG_MIN_TYPE          0x10
  61
  62 struct nlmsghdr {
  63     uint32_t nlmsg_len;
  64     uint16_t nlmsg_type;
  65     uint16_t nlmsg_flags;
  66     uint32_t nlmsg_seq;
  67     uint32_t nlmsg_pid;
  68 };
  69 BUILD_ASSERT_DECL(sizeof(struct nlmsghdr) == 16);
  70
  71 #define NLMSG_ALIGNTO 4
  72 #define NLMSG_ALIGN(SIZE) ROUND_UP(SIZE, NLMSG_ALIGNTO)
  73 #define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
  74
  75 struct nlmsgerr
  76 {
  77         int error;
  78         struct nlmsghdr msg;
  79 };
  80 BUILD_ASSERT_DECL(sizeof(struct nlmsgerr) == 20);
  81
  82 struct genlmsghdr {
  83     uint8_t cmd;
  84     uint8_t version;
  85     uint16_t reserved;
  86 };
  87 BUILD_ASSERT_DECL(sizeof(struct genlmsghdr) == 4);
  88
  89 #define GENL_HDRLEN NLMSG_ALIGN(sizeof(struct genlmsghdr))
  90
  91 struct nlattr {
  92     uint16_t nla_len;
  93     uint16_t nla_type;
  94 };
  95 BUILD_ASSERT_DECL(sizeof(struct nlattr) == 4);
  96
  97 #define NLA_ALIGNTO 4
  98 #define NLA_ALIGN(SIZE) ROUND_UP(SIZE, NLA_ALIGNTO)
  99 #define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
 100
 101 #define GENL_MIN_ID     NLMSG_MIN_TYPE
 102 #define GENL_MAX_ID     1023
 103
 104 #define GENL_ID_CTRL            NLMSG_MIN_TYPE
 105
 106 enum {
 107         CTRL_CMD_UNSPEC,
 108         CTRL_CMD_NEWFAMILY,
 109         CTRL_CMD_DELFAMILY,
 110         CTRL_CMD_GETFAMILY,
 111         CTRL_CMD_NEWOPS,
 112         CTRL_CMD_DELOPS,
 113         CTRL_CMD_GETOPS,
 114         __CTRL_CMD_MAX,
 115 };
 116
 117 #define CTRL_CMD_MAX (__CTRL_CMD_MAX - 1)
 118
 119 enum {
 120         CTRL_ATTR_UNSPEC,
 121         CTRL_ATTR_FAMILY_ID,
 122         CTRL_ATTR_FAMILY_NAME,
 123         CTRL_ATTR_VERSION,
 124         CTRL_ATTR_HDRSIZE,
 125         CTRL_ATTR_MAXATTR,
 126         CTRL_ATTR_OPS,
 127         __CTRL_ATTR_MAX,
 128 };
 129
 130 #define CTRL_ATTR_MAX (__CTRL_ATTR_MAX - 1)
 131
 132 enum {
 133         CTRL_ATTR_OP_UNSPEC,
 134         CTRL_ATTR_OP_ID,
 135         CTRL_ATTR_OP_FLAGS,
 136         __CTRL_ATTR_OP_MAX,
 137 };
 138
 139 #define CTRL_ATTR_OP_MAX (__CTRL_ATTR_OP_MAX - 1)
 140 #endif  /* !HAVE_NETLINK */
 141
 142 /* These were introduced all together in 2.6.24. */
 143 #ifndef NLA_TYPE_MASK
 144 #define NLA_F_NESTED        (1 << 15)
 145 #define NLA_F_NET_BYTEORDER (1 << 14)
 146 #define NLA_TYPE_MASK       ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
 147 #endif
 148
 149 /* These were introduced all together in 2.6.14.  (We want our programs to
 150  * support the newer kernel features even if compiled with older headers.) */
 151 #ifndef NETLINK_ADD_MEMBERSHIP
 152 #define NETLINK_ADD_MEMBERSHIP 1
 153 #define NETLINK_DROP_MEMBERSHIP 2
 154 #endif
 155
 156 /* These were introduced all together in 2.6.23.  (We want our programs to
 157  * support the newer kernel features even if compiled with older headers.) */
 158 #ifndef CTRL_ATTR_MCAST_GRP_MAX
 159
 160 #undef CTRL_ATTR_MAX
 161 #define CTRL_ATTR_MAX 7
 162 #define CTRL_ATTR_MCAST_GROUPS 7
 163
 164 enum {
 165     CTRL_ATTR_MCAST_GRP_UNSPEC,
 166     CTRL_ATTR_MCAST_GRP_NAME,
 167     CTRL_ATTR_MCAST_GRP_ID,
 168     __CTRL_ATTR_MCAST_GRP_MAX,
 169 };
 170
 171 #define CTRL_ATTR_MCAST_GRP_MAX (__CTRL_ATTR_MCAST_GRP_MAX - 1)
 172 #endif /* CTRL_ATTR_MCAST_GRP_MAX */
 173
 174 #endif /* netlink-protocol.h */