X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fnetlink.h;h=0bd2c41e60357df54dbda65aae4a34c71797420e;hb=12d685891c72d6009f0303edb94b3b6fabcd6228;hp=fd918d1cc72d010d7f15867733003c0bd40f1df0;hpb=34e63086edddcae06d7c1a4fa84fec0861e50758;p=openvswitch diff --git a/lib/netlink.h b/lib/netlink.h index fd918d1c..0bd2c41e 100644 --- a/lib/netlink.h +++ b/lib/netlink.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,41 +17,29 @@ #ifndef NETLINK_H #define NETLINK_H 1 -/* Netlink interface. +/* Netlink message helpers. * * Netlink is a datagram-based network protocol primarily for communication * between user processes and the kernel, and mainly on Linux. Netlink is * specified in RFC 3549, "Linux Netlink as an IP Services Protocol". * * Netlink is not suitable for use in physical networks of heterogeneous - * machines because host byte order is used throughout. */ + * machines because host byte order is used throughout. + * + * This header file defines helper functions for working with Netlink messages. + * For Netlink protocol definitions, see netlink-protocol.h. For + * Linux-specific definitions for Netlink sockets, see netlink-socket.h. + */ #include -#include +#include #include +#include "netlink-protocol.h" +#include "openvswitch/types.h" struct ofpbuf; -struct nl_sock; struct nlattr; -/* Netlink sockets. */ - -int nl_sock_create(int protocol, int multicast_group, - size_t so_sndbuf, size_t so_rcvbuf, - struct nl_sock **); -void nl_sock_destroy(struct nl_sock *); - -int nl_sock_send(struct nl_sock *, const struct ofpbuf *, bool wait); -int nl_sock_sendv(struct nl_sock *sock, const struct iovec iov[], size_t n_iov, - 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); - -void nl_sock_wait(const struct nl_sock *, short int events); - -/* Netlink messages. */ - /* Accessing headers and data. */ struct nlmsghdr *nl_msg_nlmsghdr(const struct ofpbuf *); struct genlmsghdr *nl_msg_genlmsghdr(const struct ofpbuf *); @@ -59,11 +47,10 @@ bool nl_msg_nlmsgerr(const struct ofpbuf *, int *error); void nl_msg_reserve(struct ofpbuf *, size_t); /* Appending headers and raw data. */ -void nl_msg_put_nlmsghdr(struct ofpbuf *, struct nl_sock *, - size_t expected_payload, +void nl_msg_put_nlmsghdr(struct ofpbuf *, size_t expected_payload, uint32_t type, uint32_t flags); -void nl_msg_put_genlmsghdr(struct ofpbuf *, struct nl_sock *, - size_t expected_payload, int family, uint32_t flags, +void nl_msg_put_genlmsghdr(struct ofpbuf *, size_t expected_payload, + int family, uint32_t flags, uint8_t cmd, uint8_t version); void nl_msg_put(struct ofpbuf *, const void *, size_t); void *nl_msg_put_uninit(struct ofpbuf *, size_t); @@ -76,8 +63,18 @@ void nl_msg_put_u8(struct ofpbuf *, uint16_t type, uint8_t value); void nl_msg_put_u16(struct ofpbuf *, uint16_t type, uint16_t value); void nl_msg_put_u32(struct ofpbuf *, uint16_t type, uint32_t value); void nl_msg_put_u64(struct ofpbuf *, uint16_t type, uint64_t value); +void nl_msg_put_be16(struct ofpbuf *, uint16_t type, ovs_be16 value); +void nl_msg_put_be32(struct ofpbuf *, uint16_t type, ovs_be32 value); +void nl_msg_put_be64(struct ofpbuf *, uint16_t type, ovs_be64 value); void nl_msg_put_string(struct ofpbuf *, uint16_t type, const char *value); -void nl_msg_put_nested(struct ofpbuf *, uint16_t type, struct ofpbuf *); + +size_t nl_msg_start_nested(struct ofpbuf *, uint16_t type); +void nl_msg_end_nested(struct ofpbuf *, size_t offset); +void nl_msg_put_nested(struct ofpbuf *, uint16_t type, + const void *data, size_t size); + +/* Separating buffers into individual messages. */ +struct nlmsghdr *nl_msg_next(struct ofpbuf *buffer, struct ofpbuf *msg); /* Netlink attribute types. */ enum nl_attr_type @@ -86,15 +83,49 @@ enum nl_attr_type NL_A_UNSPEC, NL_A_U8, NL_A_U16, + NL_A_BE16 = NL_A_U16, NL_A_U32, + NL_A_BE32 = NL_A_U32, NL_A_U64, + NL_A_BE64 = NL_A_U64, NL_A_STRING, NL_A_FLAG, NL_A_NESTED, N_NL_ATTR_TYPES }; +/* Netlink attribute iteration. */ +static inline struct nlattr * +nl_attr_next(const struct nlattr *nla) +{ + return (void *) ((uint8_t *) nla + NLA_ALIGN(nla->nla_len)); +} + +static inline bool +nl_attr_is_valid(const struct nlattr *nla, size_t maxlen) +{ + return (maxlen >= sizeof *nla + && nla->nla_len >= sizeof *nla + && NLA_ALIGN(nla->nla_len) <= maxlen); +} + +/* This macro is careful to check for attributes with bad lengths. */ +#define NL_ATTR_FOR_EACH(ITER, LEFT, ATTRS, ATTRS_LEN) \ + for ((ITER) = (ATTRS), (LEFT) = (ATTRS_LEN); \ + nl_attr_is_valid(ITER, LEFT); \ + (LEFT) -= NLA_ALIGN((ITER)->nla_len), (ITER) = nl_attr_next(ITER)) + + +/* This macro does not check for attributes with bad lengths. It should only + * be used with messages from trusted sources or with messages that have + * already been validated (e.g. with NL_ATTR_FOR_EACH). */ +#define NL_ATTR_FOR_EACH_UNSAFE(ITER, LEFT, ATTRS, ATTRS_LEN) \ + for ((ITER) = (ATTRS), (LEFT) = (ATTRS_LEN); \ + (LEFT) > 0; \ + (LEFT) -= NLA_ALIGN((ITER)->nla_len), (ITER) = nl_attr_next(ITER)) + /* Netlink attribute parsing. */ +int nl_attr_type(const struct nlattr *); const void *nl_attr_get(const struct nlattr *); size_t nl_attr_get_size(const struct nlattr *); const void *nl_attr_get_unspec(const struct nlattr *, size_t size); @@ -103,7 +134,11 @@ uint8_t nl_attr_get_u8(const struct nlattr *); uint16_t nl_attr_get_u16(const struct nlattr *); uint32_t nl_attr_get_u32(const struct nlattr *); uint64_t nl_attr_get_u64(const struct nlattr *); +ovs_be16 nl_attr_get_be16(const struct nlattr *); +ovs_be32 nl_attr_get_be32(const struct nlattr *); +ovs_be64 nl_attr_get_be64(const struct nlattr *); const char *nl_attr_get_string(const struct nlattr *); +void nl_attr_get_nested(const struct nlattr *, struct ofpbuf *); /* Netlink attribute policy. * @@ -119,9 +154,11 @@ struct nl_policy bool nl_policy_parse(const struct ofpbuf *, size_t offset, const struct nl_policy[], struct nlattr *[], size_t n_attrs); - -/* Miscellaneous. */ +bool nl_parse_nested(const struct nlattr *, const struct nl_policy[], + struct nlattr *[], size_t n_attrs); -int nl_lookup_genl_family(const char *name, int *number); +const struct nlattr *nl_attr_find(const struct ofpbuf *, size_t hdr_len, + uint16_t type); +const struct nlattr *nl_attr_find_nested(const struct nlattr *, uint16_t type); #endif /* netlink.h */