lib/netlink-protocol.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #ifndef NETLINK_PROTOCOL_H
  35 #define NETLINK_PROTOCOL_H 1
  36
  37 /* Netlink protocol definitions.
  38  *
  39  * These definitions are equivalent to those in the Linux 2.6 kernel headers,
  40  * without requiring those headers to be available. */
  41
  42 #include <stdint.h>
  43 #include <sys/socket.h>
  44 #include "util.h"
  45
  46 #define NETLINK_GENERIC         16
  47
  48 struct sockaddr_nl {
  49     sa_family_t nl_family;
  50     unsigned short int nl_pad;
  51     uint32_t nl_pid;
  52     uint32_t nl_groups;
  53 };
  54 BUILD_ASSERT_DECL(sizeof(struct sockaddr_nl) == 12);
  55
  56 /* nlmsg_flags bits. */
  57 #define NLM_F_REQUEST           0x001
  58 #define NLM_F_MULTI             0x002
  59 #define NLM_F_ACK               0x004
  60 #define NLM_F_ECHO              0x008
  61
  62 #define NLM_F_ROOT              0x100
  63 #define NLM_F_MATCH             0x200
  64 #define NLM_F_ATOMIC            0x400
  65 #define NLM_F_DUMP              (NLM_F_ROOT | NLM_F_MATCH)
  66
  67 /* nlmsg_type values. */
  68 #define NLMSG_NOOP              1
  69 #define NLMSG_ERROR             2
  70 #define NLMSG_DONE              3
  71 #define NLMSG_OVERRUN           4
  72
  73 #define NLMSG_MIN_TYPE          0x10
  74
  75 struct nlmsghdr {
  76     uint32_t nlmsg_len;
  77     uint16_t nlmsg_type;
  78     uint16_t nlmsg_flags;
  79     uint32_t nlmsg_seq;
  80     uint32_t nlmsg_pid;
  81 };
  82 BUILD_ASSERT_DECL(sizeof(struct nlmsghdr) == 16);
  83
  84 #define NLMSG_ALIGNTO 4
  85 #define NLMSG_ALIGN(SIZE) ROUND_UP(SIZE, NLMSG_ALIGNTO)
  86 #define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
  87
  88 struct nlmsgerr
  89 {
  90         int error;
  91         struct nlmsghdr msg;
  92 };
  93 BUILD_ASSERT_DECL(sizeof(struct nlmsgerr) == 20);
  94
  95 #define NETLINK_ADD_MEMBERSHIP  1
  96 #define NETLINK_DROP_MEMBERSHIP 2
  97 #define NETLINK_PKTINFO         3
  98
  99 struct genlmsghdr {
 100     uint8_t cmd;
 101     uint8_t version;
 102     uint16_t reserved;
 103 };
 104 BUILD_ASSERT_DECL(sizeof(struct genlmsghdr) == 4);
 105
 106 #define GENL_HDRLEN NLMSG_ALIGN(sizeof(struct genlmsghdr))
 107
 108 struct nlattr {
 109     uint16_t nla_len;
 110     uint16_t nla_type;
 111 };
 112 BUILD_ASSERT_DECL(sizeof(struct nlattr) == 4);
 113
 114 #define NLA_ALIGNTO 4
 115 #define NLA_ALIGN(SIZE) ROUND_UP(SIZE, NLA_ALIGNTO)
 116 #define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
 117
 118 #define GENL_MIN_ID     NLMSG_MIN_TYPE
 119 #define GENL_MAX_ID     1023
 120
 121 #define GENL_ID_CTRL            NLMSG_MIN_TYPE
 122
 123 enum {
 124         CTRL_CMD_UNSPEC,
 125         CTRL_CMD_NEWFAMILY,
 126         CTRL_CMD_DELFAMILY,
 127         CTRL_CMD_GETFAMILY,
 128         CTRL_CMD_NEWOPS,
 129         CTRL_CMD_DELOPS,
 130         CTRL_CMD_GETOPS,
 131         __CTRL_CMD_MAX,
 132 };
 133
 134 #define CTRL_CMD_MAX (__CTRL_CMD_MAX - 1)
 135
 136 enum {
 137         CTRL_ATTR_UNSPEC,
 138         CTRL_ATTR_FAMILY_ID,
 139         CTRL_ATTR_FAMILY_NAME,
 140         CTRL_ATTR_VERSION,
 141         CTRL_ATTR_HDRSIZE,
 142         CTRL_ATTR_MAXATTR,
 143         CTRL_ATTR_OPS,
 144         __CTRL_ATTR_MAX,
 145 };
 146
 147 #define CTRL_ATTR_MAX (__CTRL_ATTR_MAX - 1)
 148
 149 enum {
 150         CTRL_ATTR_OP_UNSPEC,
 151         CTRL_ATTR_OP_ID,
 152         CTRL_ATTR_OP_FLAGS,
 153         __CTRL_ATTR_OP_MAX,
 154 };
 155
 156 #define CTRL_ATTR_OP_MAX (__CTRL_ATTR_OP_MAX - 1)
 157
 158 #endif /* netlink-protocol.h */