123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154 |
- /*
- * netlink-private/route/link/api.h Link Modules API
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation version 2.1
- * of the License.
- *
- * Copyright (c) 2003-2013 Thomas Graf <tgraf@suug.ch>
- */
- #ifndef NETLINK_LINK_API_H_
- #define NETLINK_LINK_API_H_
- #include <netlink/netlink.h>
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * @ingroup link_api
- *
- * Available operations to modules implementing a link info type.
- */
- struct rtnl_link_info_ops
- {
- /** Name of link info type, must match name on kernel side */
- char * io_name;
- /** Reference count, DO NOT MODIFY */
- int io_refcnt;
- /** Called to assign an info type to a link.
- * Has to allocate enough resources to hold attributes. Can
- * use link->l_info to store a pointer. */
- int (*io_alloc)(struct rtnl_link *);
- /** Called to parse the link info attribute.
- * Must parse the attribute and assign all values to the link.
- */
- int (*io_parse)(struct rtnl_link *,
- struct nlattr *,
- struct nlattr *);
- /** Called when the link object is dumped.
- * Must dump the info type specific attributes. */
- void (*io_dump[NL_DUMP_MAX+1])(struct rtnl_link *,
- struct nl_dump_params *);
- /** Called when a link object is cloned.
- * Must clone all info type specific attributes. */
- int (*io_clone)(struct rtnl_link *, struct rtnl_link *);
- /** Called when construction a link netlink message.
- * Must append all info type specific attributes to the message. */
- int (*io_put_attrs)(struct nl_msg *, struct rtnl_link *);
- /** Called to release all resources previously allocated
- * in either io_alloc() or io_parse(). */
- void (*io_free)(struct rtnl_link *);
- struct nl_list_head io_list;
- };
- extern struct rtnl_link_info_ops *rtnl_link_info_ops_lookup(const char *);
- extern void rtnl_link_info_ops_put(struct rtnl_link_info_ops *);
- extern int rtnl_link_register_info(struct rtnl_link_info_ops *);
- extern int rtnl_link_unregister_info(struct rtnl_link_info_ops *);
- /**
- * @ingroup link_api
- *
- * Available operations to modules implementing a link address family.
- */
- struct rtnl_link_af_ops
- {
- /** The address family this operations set implements */
- const unsigned int ao_family;
- /** Number of users of this operations, DO NOT MODIFY. */
- int ao_refcnt;
- /** Validation policy for IFLA_PROTINFO attribute. This pointer
- * can be set to a nla_policy structure describing the minimal
- * requirements the attribute must meet. Failure of meeting these
- * requirements will result in a parsing error. */
- const struct nla_policy *ao_protinfo_policy;
- /** Called after address family has been assigned to link. Must
- * allocate data buffer to hold address family specific data and
- * store it in link->l_af_data. */
- void * (*ao_alloc)(struct rtnl_link *);
- /** Called when the link is cloned, must allocate a clone of the
- * address family specific buffer and return it. */
- void * (*ao_clone)(struct rtnl_link *, void *);
- /** Called when the link gets freed. Must free all allocated data */
- void (*ao_free)(struct rtnl_link *, void *);
- /** Called if a IFLA_PROTINFO attribute needs to be parsed. Typically
- * stores the parsed data in the address family specific buffer. */
- int (*ao_parse_protinfo)(struct rtnl_link *,
- struct nlattr *, void *);
- /** Called if a IFLA_AF_SPEC attribute needs to be parsed. Typically
- * stores the parsed data in the address family specific buffer. */
- int (*ao_parse_af)(struct rtnl_link *,
- struct nlattr *, void *);
- /** Called if a link message is sent to the kernel. Must append the
- * link address family specific attributes to the message. */
- int (*ao_fill_af)(struct rtnl_link *,
- struct nl_msg *msg, void *);
- /** Dump address family specific link attributes */
- void (*ao_dump[NL_DUMP_MAX+1])(struct rtnl_link *,
- struct nl_dump_params *,
- void *);
- /** Comparison function
- *
- * Will be called when two links are compared for their af data. It
- * takes two link objects in question, an object specific bitmask
- * defining which attributes should be compared and flags to control
- * the behaviour
- *
- * The function must return a bitmask with the relevant bit set for
- * each attribute that mismatches
- */
- int (*ao_compare)(struct rtnl_link *,
- struct rtnl_link *, int, uint32_t, int);
- };
- extern struct rtnl_link_af_ops *rtnl_link_af_ops_lookup(unsigned int);
- extern void rtnl_link_af_ops_put(struct rtnl_link_af_ops *);
- extern void * rtnl_link_af_alloc(struct rtnl_link *,
- const struct rtnl_link_af_ops *);
- extern void * rtnl_link_af_data(const struct rtnl_link *,
- const struct rtnl_link_af_ops *);
- extern int rtnl_link_af_register(struct rtnl_link_af_ops *);
- extern int rtnl_link_af_unregister(struct rtnl_link_af_ops *);
- extern int rtnl_link_af_data_compare(struct rtnl_link *a,
- struct rtnl_link *b,
- int family);
- #ifdef __cplusplus
- }
- #endif
- #endif
|